PFCRFFVariablesAction

construction:Undocumented Action Class

The PFCRFFVariablesAction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Creates the L nonlinear variables for the Cahn-Hilliard equation for the RFF form of the phase field crystal model

Overview

Example Input File Syntax

Creates the L nonlinear variables for the Cahn-Hilliard equation for the RFF form of the phase field crystal model

Input Parameters

L_name_baseBase name for the complex L variables
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Base name for the complex L variables
num_Lspecifies the number of complex L variables will be solved for
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:specifies the number of complex L variables will be solved for

Required 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
familyLAGRANGESpecifies the family of FE shape functions to use for the L variables
Default:LAGRANGE
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:LAGRANGE, MONOMIAL, HERMITE, SCALAR, HIERARCHIC, CLOUGH, XYZ, SZABAB, BERNSTEIN, L2_LAGRANGE, L2_HIERARCHIC, NEDELEC_ONE, LAGRANGE_VEC, MONOMIAL_VEC, RAVIART_THOMAS, RATIONAL_BERNSTEIN, SIDE_HIERARCHIC, L2_HIERARCHIC_VEC, L2_LAGRANGE_VEC, L2_RAVIART_THOMAS
Controllable:No
Description:Specifies the family of FE shape functions to use for the L variables
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.
orderFIRSTSpecifies the order of the FE shape function to use for the L variables
Default:FIRST
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH
Controllable:No
Description:Specifies the order of the FE shape function to use for the L variables
scaling1Specifies a scaling factor to apply to the L variables
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Specifies a scaling factor to apply to the L variables

Optional Parameters