FeatureVolumeFraction

under construction:Undocumented Class

The FeatureVolumeFraction 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 /Postprocessors/FeatureVolumeFraction

Input Parameters

  • feature_volumesThe feature volume VectorPostprocessorValue.

    C++ Type:VectorPostprocessorName

    Options:

    Description:The feature volume VectorPostprocessorValue.

  • mesh_volumePostprocessor from which to get mesh volume

    C++ Type:PostprocessorName

    Options:

    Description:Postprocessor from which to get mesh volume

Required Parameters

  • execute_onTIMESTEP_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.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

    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.

  • value_typeVOLUME_FRACTIONThe value to output (VOLUME_FRACTION or AVRAMI value)

    Default:VOLUME_FRACTION

    C++ Type:MooseEnum

    Options:VOLUME_FRACTION AVRAMI

    Description:The value to output (VOLUME_FRACTION or AVRAMI value)

  • equil_fraction-1Equilibrium volume fraction of 2nd phase for Avrami analysis

    Default:-1

    C++ Type:double

    Options:

    Description:Equilibrium volume fraction of 2nd phase for Avrami analysis

Optional Parameters

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • 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.

  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector

    Options:

    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object

  • 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.

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Options:

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • force_preauxFalseForces the GeneralUserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Options:

    Description:Forces the GeneralUserObject to be executed in PREAUX

Advanced Parameters

Input Files

References