Move CoupledGradientMaterial into framework and increase capabilities #30006
Conversation
|
Job Documentation, step Docs: sync website on 55b7155 wanted to post the following: View the site here This comment will be updated on new commits. |
|
Job Coverage, step Generate coverage on 55b7155 wanted to post the following: Framework coverage
Modules coverageCoverage did not change Full coverage reportsReports
This comment will be updated on new commits. |
||||||||||||||||||||||||||
| #include "Material.h" | ||
|
|
||
| /** | ||
| * A material that optinally computes two properties, one corresponding to the value of the coupled |
There was a problem hiding this comment.
I dont think it does two properties.
I think it only compute the gradient one?
There was a problem hiding this comment.
crap, those are comments from the original header.
| GenericMaterialProperty<RealVectorValue, is_ad> & _grad_mat_prop; | ||
| const GenericMaterialProperty<Real, is_ad> & _scalar_property; | ||
| const GenericVariableGradient<is_ad> & _grad_u; |
There was a problem hiding this comment.
| GenericMaterialProperty<RealVectorValue, is_ad> & _grad_mat_prop; | |
| const GenericMaterialProperty<Real, is_ad> & _scalar_property; | |
| const GenericVariableGradient<is_ad> & _grad_u; | |
| /// Material property computed, equal to the gradient of the variable | |
| GenericMaterialProperty<RealVectorValue, is_ad> & _grad_mat_prop; | |
| /// A scalar material property that acts as a factor in the computed property | |
| const GenericMaterialProperty<Real, is_ad> & _scalar_property; | |
| /// Gradient of the variable | |
| const GenericVariableGradient<is_ad> & _grad_u; |
| _scalar_property(getGenericMaterialProperty<Real, is_ad>("scalar_property")), | ||
| _grad_u(coupledGenericGradient<is_ad>("u")) | ||
| { | ||
| } |
There was a problem hiding this comment.
check if u is finite volume, and if so error because grad_u = 0 is not interesting
There was a problem hiding this comment.
hmm...whats the best way to do that?
There was a problem hiding this comment.
get a pointer to the variable and do:
if (var.isFV())
mooseError
There was a problem hiding this comment.
Wait, is that true? This was originally used in fvkernels/mms/grad-reconstruction.mat-rz for a FV variable. If I replace the gradient with all zeros, it diffs.
There was a problem hiding this comment.
interesting! i didnt know this worked
| CoupledGradientMaterialTempl<is_ad>::validParams() | ||
| { | ||
| InputParameters params = Material::validParams(); | ||
| params.addClassDescription("Create a gradient material coupled to a variable."); |
| # CoupledValueFunctionMaterial / ADCoupledGradientMaterial | ||
|
|
||
| !syntax description /Materials/CoupledGradientMaterial | ||
|
|
There was a problem hiding this comment.
let's add to the stub. ideally you would mention an example, maybe even how you are using it
| params.addParam<MaterialPropertyName>( | ||
| "scalar_property", | ||
| 1.0, | ||
| "Scalar material property multiplied by the coupled variable value and gradient."); |
There was a problem hiding this comment.
| "Scalar material property multiplied by the coupled variable value and gradient."); | |
| "Scalar material property acting as a factor in the output gradient material property."); |
| "times the scalar."); | ||
| params.deprecateParam("grad_mat_prop", "gradient_material_name", "12/12/25"); | ||
| params.addParam<MaterialPropertyName>( | ||
| "scalar_property", |
There was a problem hiding this comment.
I d deprecate this name and call it scalar_property_factor
There was a problem hiding this comment.
No need to deprecate this one, it is new. I'll change the name.
| "scalar_property", | ||
| 1.0, | ||
| "Scalar material property multiplied by the coupled variable value and gradient."); | ||
| params.addRequiredCoupledVar("u", "The coupled variable"); |
There was a problem hiding this comment.
| params.addRequiredCoupledVar("u", "The coupled variable"); | |
| params.addRequiredCoupledVar("u", "The coupled variable to take the gradient of"); |
tophmatthews
force-pushed
the
coupled_grad_mat_ad_15915
branch
from
4559867 to
b7b3363
Compare
tophmatthews
force-pushed
the
coupled_grad_mat_ad_15915
branch
from
b7b3363 to
1c4e8b4
Compare
Ref #15915