- primary_boundaryThe name of the primary boundary sideset.
C++ Type:BoundaryName
Controllable:No
Description:The name of the primary boundary sideset.
- primary_subdomainThe name of the primary subdomain.
C++ Type:SubdomainName
Controllable:No
Description:The name of the primary subdomain.
- secondary_boundaryThe name of the secondary boundary sideset.
C++ Type:BoundaryName
Controllable:No
Description:The name of the secondary boundary sideset.
- secondary_subdomainThe name of the secondary subdomain.
C++ Type:SubdomainName
Controllable:No
Description:The name of the secondary subdomain.
Mass Sorption Constraint
Enforces sorption as described by a concentration-pressure proportionality between primary and secondary sides of a mortar interface using a Lagrange multiplier.
Description
The MassSorptionConstraint class is used to enforce sorption as described by a concentration-pressure proportionality between primary () and secondary () sides of a mortar interface using a Lagrange multiplier. It enforces the constraint (1) where is the partial pressure of a species in the gap that would result from concentration () and temperature () conditions at interface side . Partial pressures can be calculated using SorptionPartialPressure.
A small non-zero shift factor, , is applied to avoid a zero pivot when inverting the Jacobian. SorptionIsothermGapInterface implements similar physics across an interface that is not separated by a gap. Unlike SorptionIsothermGapInterface, MassSorptionConstraint does not necessarily preserve mass flux. This functionality is provided by pairing it with a class such as MassFluxConstraint.
Example Input Syntax
[Constraints<<<{"href": "../../syntax/Constraints/index.html"}>>>]
[u]
type = MassSorptionConstraint<<<{"description": "Enforces sorption as described by a concentration-pressure proportionality between primary and secondary sides of a mortar interface using a Lagrange multiplier.", "href": "MassSorptionConstraint.html"}>>>
variable<<<{"description": "The name of the lagrange multiplier variable that this constraint is applied to. This parameter may not be supplied in the case of using penalty methods for example"}>>> = lm_u
primary_variable<<<{"description": "Primal variable on primary surface. If this parameter is not provided then the primary variable will be initialized to the secondary variable"}>>> = u
primary_boundary<<<{"description": "The name of the primary boundary sideset."}>>> = inner_right
primary_subdomain<<<{"description": "The name of the primary subdomain."}>>> = primary
secondary_variable<<<{"description": "Primal variable on secondary surface."}>>> = u
secondary_boundary<<<{"description": "The name of the secondary boundary sideset."}>>> = outer_left
secondary_subdomain<<<{"description": "The name of the secondary subdomain."}>>> = secondary
partial_pressure_name<<<{"description": "The name of the partial pressure if multiple partial pressure are defined on the same block"}>>> = partial_pressure
epsilon<<<{"description": "The non-zero shift factor applied to avoid a zero pivot"}>>> = 1e-9
correct_edge_dropping<<<{"description": "Whether to enable correct edge dropping treatment for mortar constraints. When disabled any Lagrange Multiplier degree of freedom on a secondary element without full primary contributions will be set (strongly) to 0."}>>> = true
[]
[](test/tests/sorption_constraint/test.i)Here, the partial pressures on the two sides of the interface are calculated using SorptionPartialPressure as shown below.
[Materials<<<{"href": "../../syntax/Materials/index.html"}>>>]
[partial_pressure_inner]
type = ADSorptionPartialPressure<<<{"description": "Computes the sorption partial pressure of a solute in a material.", "href": "../materials/SorptionPartialPressure.html"}>>>
A<<<{"description": "Temperature-independent coefficient of the intercept term in the concentration-pressure proportionality"}>>> = 19.3
B<<<{"description": "Temperature-dependent coefficient of the intercept term in the concentration-pressure proportionality"}>>> = -47300
D<<<{"description": "Temperature-independent coefficient of the order in the concentration-pressure proportionality"}>>> = 1.51
E<<<{"description": "Temperature-dependent coefficient of the order in the concentration-pressure proportionality"}>>> = 4340
d1<<<{"description": "Temperature-independent coefficient of the transition concentration"}>>> = 3.4
d2<<<{"description": "Temperature-dependent coefficient of the transition concentration"}>>> = 6.15e-4
unit_scale<<<{"description": "Unit conversion factor used to scale the concentration"}>>> = 1
density<<<{"description": "Mass density of the material"}>>> = density
concentration<<<{"description": "The coupled concentration variable"}>>> = u
temperature<<<{"description": "The coupled temperature variable"}>>> = temperature
block<<<{"description": "The list of blocks (ids or names) that this object will be applied"}>>> = inner
outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = 'all'
output_properties<<<{"description": "List of material properties, from this material, to output (outputs must also be defined to an output type)"}>>> = partial_pressure
[]
[](test/tests/sorption_constraint/test.i)[Materials<<<{"href": "../../syntax/Materials/index.html"}>>>]
[partial_pressure_outer]
type = ADSorptionPartialPressure<<<{"description": "Computes the sorption partial pressure of a solute in a material.", "href": "../materials/SorptionPartialPressure.html"}>>>
A<<<{"description": "Temperature-independent coefficient of the intercept term in the concentration-pressure proportionality"}>>> = 24
B<<<{"description": "Temperature-dependent coefficient of the intercept term in the concentration-pressure proportionality"}>>> = -35700
D<<<{"description": "Temperature-independent coefficient of the order in the concentration-pressure proportionality"}>>> = -1.56
E<<<{"description": "Temperature-dependent coefficient of the order in the concentration-pressure proportionality"}>>> = 6120
d1<<<{"description": "Temperature-independent coefficient of the transition concentration"}>>> = 2.04
d2<<<{"description": "Temperature-dependent coefficient of the transition concentration"}>>> = 1.79e-3
unit_scale<<<{"description": "Unit conversion factor used to scale the concentration"}>>> = 1
density<<<{"description": "Mass density of the material"}>>> = density
concentration<<<{"description": "The coupled concentration variable"}>>> = u
temperature<<<{"description": "The coupled temperature variable"}>>> = temperature
block<<<{"description": "The list of blocks (ids or names) that this object will be applied"}>>> = outer
outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = 'all'
output_properties<<<{"description": "List of material properties, from this material, to output (outputs must also be defined to an output type)"}>>> = partial_pressure
[]
[](test/tests/sorption_constraint/test.i)Input Parameters
- aux_lmAuxiliary Lagrange multiplier variable that is utilized together with the Petrov-Galerkin approach.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Auxiliary Lagrange multiplier variable that is utilized together with the Petrov-Galerkin approach.
- compute_lm_residualsTrueWhether to compute Lagrange Multiplier residuals
Default:True
C++ Type:bool
Controllable:No
Description:Whether to compute Lagrange Multiplier residuals
- compute_primal_residualsTrueWhether to compute residuals for the primal variable.
Default:True
C++ Type:bool
Controllable:No
Description:Whether to compute residuals for the primal variable.
- correct_edge_droppingFalseWhether to enable correct edge dropping treatment for mortar constraints. When disabled any Lagrange Multiplier degree of freedom on a secondary element without full primary contributions will be set (strongly) to 0.
Default:False
C++ Type:bool
Controllable:No
Description:Whether to enable correct edge dropping treatment for mortar constraints. When disabled any Lagrange Multiplier degree of freedom on a secondary element without full primary contributions will be set (strongly) to 0.
- debug_meshFalseWhether this constraint is going to enable mortar segment mesh debug information. An exodusfile will be generated if the user sets this flag to true
Default:False
C++ Type:bool
Controllable:No
Description:Whether this constraint is going to enable mortar segment mesh debug information. An exodusfile will be generated if the user sets this flag to true
- epsilon1e-09The non-zero shift factor applied to avoid a zero pivot
Default:1e-09
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The non-zero shift factor applied to avoid a zero pivot
- ghost_higher_d_neighborsFalseWhether we should ghost higher-dimensional neighbors. This is necessary when we are doing second order mortar with finite volume primal variables, because in order for the method to be second order we must use cell gradients, which couples in the neighbor cells.
Default:False
C++ Type:bool
Controllable:No
Description:Whether we should ghost higher-dimensional neighbors. This is necessary when we are doing second order mortar with finite volume primal variables, because in order for the method to be second order we must use cell gradients, which couples in the neighbor cells.
- ghost_point_neighborsFalseWhether we should ghost point neighbors of secondary face elements, and consequently also their mortar interface couples.
Default:False
C++ Type:bool
Controllable:No
Description:Whether we should ghost point neighbors of secondary face elements, and consequently also their mortar interface couples.
- interpolate_normalsTrueWhether to interpolate the nodal normals (e.g. classic idea of evaluating field at quadrature points). If this is set to false, then non-interpolated nodal normals will be used, and then the _normals member should be indexed with _i instead of _qp
Default:True
C++ Type:bool
Controllable:No
Description:Whether to interpolate the nodal normals (e.g. classic idea of evaluating field at quadrature points). If this is set to false, then non-interpolated nodal normals will be used, and then the _normals member should be indexed with _i instead of _qp
- minimum_projection_angle40Parameter to control which angle (in degrees) is admissible for the creation of mortar segments. If set to a value close to zero, very oblique projections are allowed, which can result in mortar segments solving physics not meaningfully, and overprojection of primary nodes onto the mortar segment mesh in extreme cases. This parameter is mostly intended for mortar mesh debugging purposes in two dimensions.
Default:40
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Parameter to control which angle (in degrees) is admissible for the creation of mortar segments. If set to a value close to zero, very oblique projections are allowed, which can result in mortar segments solving physics not meaningfully, and overprojection of primary nodes onto the mortar segment mesh in extreme cases. This parameter is mostly intended for mortar mesh debugging purposes in two dimensions.
- partial_pressure_namepartial_pressureThe name of the partial pressure if multiple partial pressure are defined on the same block
Default:partial_pressure
C++ Type:std::string
Controllable:No
Description:The name of the partial pressure if multiple partial pressure are defined on the same block
- periodicFalseWhether this constraint is going to be used to enforce a periodic condition. This has the effect of changing the normals vector for projection from outward to inward facing
Default:False
C++ Type:bool
Controllable:No
Description:Whether this constraint is going to be used to enforce a periodic condition. This has the effect of changing the normals vector for projection from outward to inward facing
- primary_variablePrimal variable on primary surface. If this parameter is not provided then the primary variable will be initialized to the secondary variable
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:Primal variable on primary surface. If this parameter is not provided then the primary variable will be initialized to the secondary variable
- quadratureDEFAULTQuadrature rule to use on mortar segments. For 2D mortar DEFAULT is recommended. For 3D mortar, QUAD meshes are integrated using triangle mortar segments. While DEFAULT quadrature order is typically sufficiently accurate, exact integration of QUAD mortar faces requires SECOND order quadrature for FIRST variables and FOURTH order quadrature for SECOND order variables.
Default:DEFAULT
C++ Type:MooseEnum
Controllable:No
Description:Quadrature rule to use on mortar segments. For 2D mortar DEFAULT is recommended. For 3D mortar, QUAD meshes are integrated using triangle mortar segments. While DEFAULT quadrature order is typically sufficiently accurate, exact integration of QUAD mortar faces requires SECOND order quadrature for FIRST variables and FOURTH order quadrature for SECOND order variables.
- secondary_variablePrimal variable on secondary surface.
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:Primal variable on secondary surface.
- use_petrov_galerkinFalseWhether to use the Petrov-Galerkin approach for the mortar-based constraints. If set to true, we use the standard basis as the test function and dual basis as the shape function for the interpolation of the Lagrange multiplier variable.
Default:False
C++ Type:bool
Controllable:No
Description:Whether to use the Petrov-Galerkin approach for the mortar-based constraints. If set to true, we use the standard basis as the test function and dual basis as the shape function for the interpolation of the Lagrange multiplier variable.
- variableThe name of the lagrange multiplier variable that this constraint is applied to. This parameter may not be supplied in the case of using penalty methods for example
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the lagrange multiplier variable that this constraint is applied to. This parameter may not be supplied in the case of using penalty methods for example
Optional Parameters
- absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution
C++ Type:std::vector<TagName>
Controllable:No
Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution
- extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
Controllable:No
Description:The extra tags for the matrices this Kernel should fill
- extra_vector_tagsThe extra tags for the vectors this Kernel should fill
C++ Type:std::vector<TagName>
Controllable:No
Description:The extra tags for the vectors this Kernel should fill
- matrix_tagssystemThe tag for the matrices this Kernel should fill
Default:system
C++ Type:MultiMooseEnum
Controllable:No
Description:The tag for the matrices this Kernel should fill
- vector_tagsnontimeThe tag for the vectors this Kernel should fill
Default:nontime
C++ Type:MultiMooseEnum
Controllable:No
Description:The tag for the vectors this Kernel should fill
Contribution To Tagged Field Data 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
- 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.