GasBase

buildconstruction:Undocumented Class

The GasBase 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.

Material properties of electrons(Defines reaction properties with Townsend coefficients)

Overview

Example Input File Syntax

Input Parameters

  • interp_elastic_coeffFalseWhether to interpolate the elastic collision townsend coefficient as a function of the mean energy. If false, coeffs are constant.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether to interpolate the elastic collision townsend coefficient as a function of the mean energy. If false, coeffs are constant.

  • interp_trans_coeffsFalseWhether to interpolate transport coefficients as a function of the mean energy. If false, coeffs are constant.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether to interpolate transport coefficients as a function of the mean energy. If false, coeffs are constant.

  • position_unitsUnits of position.

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Units of position.

  • potential_unitsThe potential units.

    C++ Type:std::string

    Unit:(no unit assumed)

    Controllable:No

    Description:The potential units.

  • property_tables_fileThe file containing interpolation tables for material properties.

    C++ Type:FileName

    Unit:(no unit assumed)

    Controllable:No

    Description:The file containing interpolation tables for material properties.

  • ramp_trans_coeffsFalseWhether to ramp the non-linearity of coming from the electron energy dependence of the transport coefficients.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether to ramp the non-linearity of coming from the electron energy dependence of the transport coefficients.

  • use_molesFalseWhether to use units of moles as opposed to # of molecules.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether to use units of moles as opposed to # of molecules.

Required Parameters

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

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

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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.

  • emSpecies concentration needed to calculate the poisson source

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Species concentration needed to calculate the poisson source

  • ipThe ion density.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The ion density.

  • mean_enThe electron mean energy in log form.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The electron mean energy in log form.

  • potentialThe potential for calculating the electron velocity

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The potential for calculating the electron velocity

  • 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

    Unit:(no unit assumed)

    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.

  • user_Richardson_coefficient1.20173e+06The Richardson coefficient.

    Default:1.20173e+06

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The Richardson coefficient.

  • user_T_gas300The gas temperature in Kelvin.

    Default:300

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The gas temperature in Kelvin.

  • user_cathode_temperature300The cathode temperature in Kelvin.

    Default:300

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The cathode temperature in Kelvin.

  • user_field_enhancement1The field enhancement factor.

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The field enhancement factor.

  • user_p_gas101000The gas pressure in Pascals.

    Default:101000

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The gas pressure in Pascals.

  • user_relative_permittivity1Multiplies the permittivity of free space.

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Multiplies the permittivity of free space.

  • user_se_coeff0.15The secondary electron emission coefficient.

    Default:0.15

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The secondary electron emission coefficient.

  • user_work_function5The work function.

    Default:5

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The work function.

Optional Parameters

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

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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    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