CammiModerator

buildconstruction:Undocumented Class

The CammiModerator 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 a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Declares material properties based on names and values prescribed by input parameters.

Overview

Example Input File Syntax

Input Parameters

  • interp_typeThe type of interpolation to perform.

    C++ Type:MooseEnum

    Options:bicubic, spline, monotone_cubic, linear, none, least_squares

    Controllable:No

    Description:The type of interpolation to perform.

  • num_groupsThe number of groups the energy spectrum is divided into.

    C++ Type:unsigned int

    Controllable:No

    Description:The number of groups the energy spectrum is divided into.

  • num_precursor_groupsThe number of delayed neutron precursor groups.

    C++ Type:unsigned int

    Controllable:No

    Description:The number of delayed neutron precursor groups.

  • prop_namesThe names of the properties this material will have

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:The names of the properties this material will have

  • prop_valuesThe values associated with the named properties

    C++ Type:std::vector<double>

    Controllable:Yes

    Description:The values associated with the named properties

  • property_tables_rootThe file root name containing interpolation tables for material properties.

    C++ Type:std::string

    Controllable:No

    Description:The file root name containing interpolation tables for material properties.

Required Parameters

  • blockThe list of blocks (ids or names) that this object will be applied

    C++ Type:std::vector<SubdomainName>

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

    Default:NONE

    C++ Type:MooseEnum

    Options:NONE, ELEMENT, SUBDOMAIN

    Controllable:No

    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

  • controller_gain0.01For every W/cm^3 that the peak power density is greater than the peak power density set point, the absorption cross section gets incremented by this amount

    Default:0.01

    C++ Type:double

    Controllable:No

    Description:For every W/cm^3 that the peak power density is greater than the peak power density set point, the absorption cross section gets incremented by this amount

  • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

  • fuel_temp_pointsThe fuel temperature interpolation points.

    C++ Type:std::vector<double>

    Controllable:No

    Description:The fuel temperature interpolation points.

  • materialMust specify either *fuel* or *moderator*.

    C++ Type:std::string

    Controllable:No

    Description:Must specify either *fuel* or *moderator*.

  • mod_temp_pointsThe moderator temperature interpolation points.

    C++ Type:std::vector<double>

    Controllable:No

    Description:The moderator temperature interpolation points.

  • other_temp0If doing bivariable interpolation, need to supply a postprocessor for the average temperature of the other material.

    Default:0

    C++ Type:PostprocessorName

    Controllable:No

    Description:If doing bivariable interpolation, need to supply a postprocessor for the average temperature of the other material.

  • peak_power_density0The postprocessor which holds the peak power density.

    Default:0

    C++ Type:PostprocessorName

    Controllable:No

    Description:The postprocessor which holds the peak power density.

  • peak_power_density_set_point10The peak power density set point in W/cm^3

    Default:10

    C++ Type:double

    Controllable:No

    Description:The peak power density set point in W/cm^3

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • sss2_inputTrueWhether serpent 2 was used to generate the input files.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether serpent 2 was used to generate the input files.

  • temperature937.0The temperature field for determining group constants.

    Default:937.0

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:The temperature field for determining group constants.

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Optional Parameters

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

    C++ Type:std::vector<std::string>

    Controllable:No

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Controllable:No

    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

    Controllable:No

    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

  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

  • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

    Default:none

    C++ Type:std::vector<OutputName>

    Controllable:No

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

Outputs Parameters

Input Files