- free_energyBase name of the free energy function F defined in a free energy material
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:Base name of the free energy function F defined in a free energy material
NonconservedAction
Set up the variable and the kernels needed for a non-conserved phase field variable
This action simplifies the input file syntax for creating a nonconserved phase field variable in the phase field module. It creates the variable and all required kernels needed to solve for a nonconserved variable.
Variables
The name of the nonconserved variable is the block name.
Kernels
The kernels that are added are:
Input Parameters
- active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:If specified only the blocks named will be visited and made active
- blockBlock restriction for the variables and kernels
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:Block restriction for the variables and kernels
- coupled_variablesVector of nonlinear variable arguments this kernel depends on
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of nonlinear variable arguments this kernel depends on
- familyLAGRANGESpecifies the family of FE shape functions to use for this variable
Default:LAGRANGE
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:Specifies the family of FE shape functions to use for this variable
- inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:If specified blocks matching these identifiers will be skipped.
- kappakappa_opThe kappa used with the kernel
Default:kappa_op
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:The kappa used with the kernel
- mobilityLThe mobility used with the kernel
Default:L
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:The mobility used with the kernel
- orderFIRSTSpecifies the order of the FE shape function to use for this variable
Default:FIRST
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:Specifies the order of the FE shape function to use for this variable
- variable_mobilityTrueThe mobility is a function of any MOOSE variable (if this is set to false, L must be constant over the entire domain!)
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:The mobility is a function of any MOOSE variable (if this is set to false, L must be constant over the entire domain!)
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- implicitTrueWhether kernels are implicit or not
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether kernels are implicit or not
- scaling1Specifies a scaling factor to apply to this variable
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Specifies a scaling factor to apply to this variable
- use_displaced_meshFalseWhether to use displaced mesh in the kernels
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to use displaced mesh in the kernels