SpeciesSourceMaterial

Computes mass source (mol/m^3/s).

Description

This material computes a species source term material property. The source term for silver, cesium, and strontium is computed according to TRISOUtils. It is also possible to define a custom source term. The initial calculation results in a value in mol/fission. This is multiplied by the fission rate, resulting in mol/m/s. The total is also computed in units of mol/m.

See also SpeciesSourceRate.

Example Input Syntax

[Materials<<<{"href": "../../syntax/Materials/index.html"}>>>]
  [conc_generation]
    type = SpeciesSourceMaterial<<<{"description": "Computes mass source (mol/m^3/s).", "href": "SpeciesSourceMaterial.html"}>>>
    property_name<<<{"description": "Name to use for the mass source material property."}>>> = conc_generation
    kind<<<{"description": "Which kind of mass source to compute."}>>> = Ag
  []
[]
(test/tests/species_source/Ag_exact.i)

Input Parameters

  • kindWhich kind of mass source to compute.

    C++ Type:MooseEnum

    Options:custom, Ag, Cs, Sr, Kr, Xe

    Controllable:No

    Description:Which kind of mass source to compute.

  • property_nameName to use for the mass source material property.

    C++ Type:std::string

    Controllable:No

    Description:Name to use for the mass source material property.

Required Parameters

  • additional_functionAdditional function to apply (requires additional_function_property).

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Additional function to apply (requires additional_function_property).

  • additional_function_propertyName of material property to be used to evaluate additional_function.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Name of material property to be used to evaluate additional_function.

  • 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

  • burnup_nameburnupName of the burnup material.

    Default:burnup

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:Name of the burnup material.

  • 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

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

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

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

  • fission_ratefission_rateCoupled fission rate.

    Default:fission_rate

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:Coupled fission rate.

  • initial_enrichmentInitial enrichment fraction of U235 (wt percent).

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Initial enrichment fraction of U235 (wt percent).

  • species_source_function1A function that describes the mass source.

    Default:1

    C++ Type:FunctionName

    Unit:(no unit assumed)

    Controllable:No

    Description:A function that describes the mass source.

  • time_average_mass_rateTrueWhether to average the mass rate with the previous mass rate when computing the total mass.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether to average the mass rate with the previous mass rate when computing the total mass.

  • total_property_nameName to use for the total mass (time integral of property_name). If not given, the value of property_name appended with '_total' will be used.

    C++ Type:std::string

    Controllable:No

    Description:Name to use for the total mass (time integral of property_name). If not given, the value of property_name appended with '_total' will be used.

  • value1Leading coefficient.

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Leading coefficient.

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

  • 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

    Unit:(no unit assumed)

    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.

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

Material Property Retrieval Parameters

Input Files

References

No citations exist within this document.