PFCRFFEnergyDensity

under construction:Undocumented Class

The PFCRFFEnergyDensity has not been documented. The content contained on this page includes the basic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /AuxKernels/PFCRFFEnergyDensity

Input Parameters

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Options:

    Description:The name of the variable that this object applies to

  • log_approachWhich approach will be used to handle the natural log

    C++ Type:MooseEnum

    Options:tolerance cancelation expansion nothing

    Description:Which approach will be used to handle the natural log

  • vArray of coupled variables

    C++ Type:std::vector

    Options:

    Description:Array of coupled variables

Required Parameters

  • a1Modified Coefficent in Taylor Series Expanstion

    Default:1

    C++ Type:double

    Options:

    Description:Modified Coefficent in Taylor Series Expanstion

  • c1Modified Coefficent in Taylor Series Expanstion

    Default:1

    C++ Type:double

    Options:

    Description:Modified Coefficent in Taylor Series Expanstion

  • b1Modified Coefficent in Taylor Series Expanstion

    Default:1

    C++ Type:double

    Options:

    Description:Modified Coefficent in Taylor Series Expanstion

  • num_exp_terms4This is the number of terms to use in the taylor series expansion

    Default:4

    C++ Type:unsigned int

    Options:

    Description:This is the number of terms to use in the taylor series expansion

  • tol1e-09Tolerance used when the tolerance approach is chosen

    Default:1e-09

    C++ Type:double

    Options:

    Description:Tolerance used when the tolerance approach is chosen

  • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

    Default:LINEAR TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Options:

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Options:

    Description:The list of block ids (SubdomainID) that this object will be applied

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The seed for the master random number generator

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

Input Files

References