Enclosure0D

Base class for components that are defined using actions.

This 0D ActionComponent represents an enclosure. An enclosure in TMAP8 is a point-volume in which a species can concentrate, dissolve, or be released.

Interaction with common TMAP8 Physics

The "physics" parameter of an EnclosureD can be used to define the Physics that should be active on the structure. See more details on the ComponentPhysicsInterface page.

Material properties

To vary the material properties used in each Physics, one can set the "property_names" and "property_values" parameters in the Enclosure0D. See more details on the ComponentMaterialPropertyInterface page.

For a Species Solubility in 0D Structures / SorptionExchangePhysics to be used you can define on the Enclosure0D:

Input Parameters

  • physicsPhysics object(s) active on the Component

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

    Controllable:No

    Description:Physics object(s) active on the Component

  • speciesThe species that are reacting, advecting, and diffusing throughout the simulation domain

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The species that are reacting, advecting, and diffusing throughout the simulation domain

Required Parameters

  • species_scaling_factorsScaling factors to make the (non)linear system better conditioned

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Scaling factors to make the (non)linear system better conditioned

  • verboseFalseWhether the component setup should be verbose

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether the component setup should be verbose

Optional Parameters

  • connected_structuresStructure exchanging species with the enclosure

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

    Controllable:No

    Description:Structure exchanging species with the enclosure

  • connection_boundariesSurface between the enclosure and the connected structures. This surface should exist on the mesh and likely be located on the 'connected_structures'

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

    Controllable:No

    Description:Surface between the enclosure and the connected structures. This surface should exist on the mesh and likely be located on the 'connected_structures'

  • connection_boundaries_areaContact surface with each structure [m^3]

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Contact surface with each structure [m^3]

Enclosure Connections To Structures 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.

Advanced Parameters

  • define_functor_propertiesTrueIf true, define functor properties from the values provided

    Default:True

    C++ Type:bool

    Controllable:No

    Description:If true, define functor properties from the values provided

  • define_material_propertiesTrueIf true, define material properties from the values provided

    Default:True

    C++ Type:bool

    Controllable:No

    Description:If true, define material properties from the values provided

  • property_namesList of material properties that should be defined on this ActionComponent

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

    Controllable:No

    Description:List of material properties that should be defined on this ActionComponent

  • property_valuesFunctors that provide the values of the material property on this ActionComponent. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Functors that provide the values of the material property on this ActionComponent. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • use_ad_for_propertiesTrueWhether to use automatic differentiation for the properties defined

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether to use automatic differentiation for the properties defined

Material And Functor Property Parameters

  • equilibrium_constantsSolubility constants for each specie. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Solubility constants for each specie. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • species_initial_pressuresInitial partial pressures for the enclosure species in Pascals. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Initial partial pressures for the enclosure species in Pascals. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

Species Parameters

  • temperatureEnclosure temperature [K]. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Enclosure temperature [K]. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

Enclosure Conditions Parameters

  • volumeVolume of enclosure [m^3]

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Volume of enclosure [m^3]

Geometry Parameters