ParametricTrappingMaterial

buildconstruction:Undocumented Class

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

Overview

Example Input File Syntax

Input Parameters

  • D0The diffusion pre-exponential factor

    C++ Type:double

    Options:

    Description:The diffusion pre-exponential factor

  • E1Trap detrapping energy in eV

    C++ Type:double

    Options:

    Description:Trap detrapping energy in eV

  • E2Trap detrapping energy in eV

    C++ Type:double

    Options:

    Description:Trap detrapping energy in eV

  • E3Trap detrapping energy in eV

    C++ Type:double

    Options:

    Description:Trap detrapping energy in eV

  • E_diffdiffusion energy in eV

    C++ Type:double

    Options:

    Description:diffusion energy in eV

  • incident_fluxincident flux

    C++ Type:double

    Options:

    Description:incident flux

  • k_boltzBoltzman constant

    C++ Type:double

    Options:

    Description:Boltzman constant

  • lambdaLattice constant in m-1

    C++ Type:double

    Options:

    Description:Lattice constant in m-1

  • n1possible trapping sites

    C++ Type:double

    Options:

    Description:possible trapping sites

  • n2possible trapping sites

    C++ Type:double

    Options:

    Description:possible trapping sites

  • n3possible trapping sites

    C++ Type:double

    Options:

    Description:possible trapping sites

  • n_soldensity of interstitial sites

    C++ Type:double

    Options:

    Description:density of interstitial sites

  • particle_energyparticle_energy

    C++ Type:double

    Options:

    Description:particle_energy

  • v1pre-exponential detrapping factor in Arrhenious eq.

    C++ Type:double

    Options:

    Description:pre-exponential detrapping factor in Arrhenious eq.

  • v2pre-exponential detrapping factor in Arrhenious eq.

    C++ Type:double

    Options:

    Description:pre-exponential detrapping factor in Arrhenious eq.

  • v3pre-exponential detrapping factor in Arrhenious eq.

    C++ Type:double

    Options:

    Description:pre-exponential detrapping factor in Arrhenious eq.

Required Parameters

  • Temperaturesimulation temperature

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

    Options:

    Description:simulation temperature

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

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

    Options:

    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 boundary condition applies

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

    Options:

    Description:The list of boundaries (ids or names) from the mesh where this boundary condition 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

    Options:

    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

    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

    Options:

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

  • 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

    Options:

    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.

Optional Parameters

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

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

    Options:

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    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

    Options:

    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

    Options:

    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

    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.

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>

    Options:

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

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

    Default:none

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

    Options:

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

Outputs Parameters