- DensityThe variable to be normalized in log form
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The variable to be normalized in log form
- normalizationThe postprocessor to be the denominator
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The postprocessor to be the denominator
- variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this object applies to
DensityNormalization
Similar to NormalizationAux except meant to normalize variables expressed in log form
Overview
DensityNormalization is similar to NormalizationAux, except it normalizes a variable in logarithmic form based on a Postprocessor value.
The formulation of DensityNormalization is defined as
warningwarning:Untested Class
The DensityNormalization does not have a formalized test, yet. For this reason, users should be aware of unforeseen bugs when using DensityNormalization. To report a bug or discuss future contributions to Zapdos, please refer to the Zapdos GitHub Discussions page. For standards of how to contribute to Zapdos and the MOOSE framework, please refer to the MOOSE Contributing page.
Example Input File Syntax
[AuxKernels]
[Normalized_Electrons]
type = DensityNormalization
variable = norm_electrons
Density = electrons
normalization = max_electron
[]
[]
Input 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
- check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
- execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
- normal_factor1The normalization factor
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The normalization factor
- shiftThe postprocessor to shift the source
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The postprocessor to shift the source
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.
- 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
- 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.