https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
SwitchingFunctionConstraintEta Class Reference

SwitchingFunctionConstraintEta is a constraint kernel that acts on the lambda lagrange multiplier non-linear variables to enforce \( \sum_n h_i(\eta_i) \equiv 1 \). More...

#include <SwitchingFunctionConstraintEta.h>

Inheritance diagram for SwitchingFunctionConstraintEta:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 SwitchingFunctionConstraintEta (const InputParameters &parameters)
 
const GenericMaterialProperty< U, is_ad > & getDefaultMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< U, is_ad > & getDefaultMaterialPropertyByName (const std::string &name)
 
void validateDerivativeMaterialPropertyBase (const std::string &base)
 
const MaterialPropertyName derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
void validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
 
void validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
void validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
 
void validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
void validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
void validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
const MaterialPropertyName propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 
const MaterialPropertyName propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

virtual Real computeQpResidual ()
 
virtual Real computeQpJacobian ()
 
virtual Real computeQpOffDiagJacobian (unsigned int)
 

Protected Attributes

VariableName _eta_name
 Switching function name.
 
const VariableValue & _lambda
 Lagrange multiplier.
 
unsigned int _lambda_var
 
const MaterialProperty< Real > & _dh
 Switching function drivatives.
 
const MaterialProperty< Real > & _d2h
 
std::vector< const MaterialProperty< Real > * > _d2ha
 
const JvarMap & _d2ha_map
 

Private Member Functions

bool haveMaterialProperty (const std::string &prop_name)
 
std::vector< VariableName > buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)
 
void validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)
 
bool isNotObjectVariable (const VariableName &name)
 

Private Attributes

FEProblemBase & _dmi_fe_problem
 

Detailed Description

SwitchingFunctionConstraintEta is a constraint kernel that acts on the lambda lagrange multiplier non-linear variables to enforce \( \sum_n h_i(\eta_i) \equiv 1 \).

Definition at line 21 of file SwitchingFunctionConstraintEta.h.

Constructor & Destructor Documentation

◆ SwitchingFunctionConstraintEta()

SwitchingFunctionConstraintEta::SwitchingFunctionConstraintEta ( const InputParameters &  parameters)

Definition at line 29 of file SwitchingFunctionConstraintEta.C.

30 : DerivativeMaterialInterface<JvarMapKernelInterface<Kernel>>(parameters),
31 _eta_name(_var.name()),
32 _dh(getMaterialPropertyDerivative<Real>("h_name", _eta_name)),
33 _d2h(getMaterialPropertyDerivative<Real>("h_name", _eta_name, _eta_name)),
34 _d2ha(coupledComponents("coupled_variables")),
35 _d2ha_map(getParameterJvarMap("coupled_variables")),
36 _lambda(coupledValue("lambda")),
37 _lambda_var(coupled("lambda"))
38{
39 for (std::size_t i = 0; i < _d2ha.size(); ++i)
40 _d2ha[i] = &getMaterialPropertyDerivative<Real>(
41 "h_name", _eta_name, coupledName("coupled_variables", i));
42}
SwitchingFunctionConstraintEta::_d2ha
std::vector< const MaterialProperty< Real > * > _d2ha
Definition SwitchingFunctionConstraintEta.h:40
SwitchingFunctionConstraintEta::_d2h
const MaterialProperty< Real > & _d2h
Definition SwitchingFunctionConstraintEta.h:39
SwitchingFunctionConstraintEta::_eta_name
VariableName _eta_name
Switching function name.
Definition SwitchingFunctionConstraintEta.h:35
SwitchingFunctionConstraintEta::_lambda
const VariableValue & _lambda
Lagrange multiplier.
Definition SwitchingFunctionConstraintEta.h:45
SwitchingFunctionConstraintEta::_dh
const MaterialProperty< Real > & _dh
Switching function drivatives.
Definition SwitchingFunctionConstraintEta.h:38

Member Function Documentation

◆ computeQpJacobian()

Real SwitchingFunctionConstraintEta::computeQpJacobian ( )
protectedvirtual

Definition at line 51 of file SwitchingFunctionConstraintEta.C.

52{
53 return _lambda[_qp] * _d2h[_qp] * _phi[_j][_qp] * _test[_i][_qp];
54}

◆ computeQpOffDiagJacobian()

Real SwitchingFunctionConstraintEta::computeQpOffDiagJacobian ( unsigned int  jvar)
protectedvirtual

Definition at line 57 of file SwitchingFunctionConstraintEta.C.

58{
59 if (jvar == _lambda_var)
60 return _phi[_j][_qp] * _dh[_qp] * _test[_i][_qp];
61
62 auto k = mapJvarToCvar(jvar, _d2ha_map);
63 if (k >= 0)
64 return _lambda[_qp] * (*_d2ha[k])[_qp] * _phi[_j][_qp] * _test[_i][_qp];
65
66 return 0.0;
67}

◆ computeQpResidual()

Real SwitchingFunctionConstraintEta::computeQpResidual ( )
protectedvirtual

Definition at line 45 of file SwitchingFunctionConstraintEta.C.

46{
47 return _lambda[_qp] * _dh[_qp] * _test[_i][_qp];
48}

◆ validParams()

InputParameters SwitchingFunctionConstraintEta::validParams ( )
static

Definition at line 15 of file SwitchingFunctionConstraintEta.C.

16{
17 InputParameters params = Kernel::validParams();
18 params.addClassDescription("Lagrange multiplier kernel to constrain the sum of all switching "
19 "functions in a multiphase system. This kernel acts on a "
20 "non-conserved order parameter eta_i.");
21 params.addParam<MaterialPropertyName>("h_name",
22 "Switching Function Materials that provides h(eta_i)");
23 params.addRequiredCoupledVar("lambda", "Lagrange multiplier");
24 params.addCoupledVar("coupled_variables",
25 "Vector of further variable arguments to the switching function");
26 return params;
27}
InputParameters::addRequiredCoupledVar
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
InputParameters::addCoupledVar
void addCoupledVar(const std::string &name, const std::string &doc_string)
Kernel::validParams
static InputParameters validParams()

Member Data Documentation

◆ _d2h

const MaterialProperty<Real>& SwitchingFunctionConstraintEta::_d2h
protected

Definition at line 39 of file SwitchingFunctionConstraintEta.h.

Referenced by computeQpJacobian().

◆ _d2ha

std::vector<const MaterialProperty<Real> *> SwitchingFunctionConstraintEta::_d2ha
protected

Definition at line 40 of file SwitchingFunctionConstraintEta.h.

Referenced by computeQpOffDiagJacobian(), and SwitchingFunctionConstraintEta().

◆ _d2ha_map

const JvarMap& SwitchingFunctionConstraintEta::_d2ha_map
protected

Definition at line 41 of file SwitchingFunctionConstraintEta.h.

Referenced by computeQpOffDiagJacobian().

◆ _dh

const MaterialProperty<Real>& SwitchingFunctionConstraintEta::_dh
protected

Switching function drivatives.

Definition at line 38 of file SwitchingFunctionConstraintEta.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

◆ _eta_name

VariableName SwitchingFunctionConstraintEta::_eta_name
protected

Switching function name.

Definition at line 35 of file SwitchingFunctionConstraintEta.h.

Referenced by SwitchingFunctionConstraintEta().

◆ _lambda

const VariableValue& SwitchingFunctionConstraintEta::_lambda
protected

Lagrange multiplier.

Definition at line 45 of file SwitchingFunctionConstraintEta.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

◆ _lambda_var

unsigned int SwitchingFunctionConstraintEta::_lambda_var
protected

Definition at line 46 of file SwitchingFunctionConstraintEta.h.

Referenced by computeQpOffDiagJacobian().

The documentation for this class was generated from the following files:
Generated on Wed Aug 26 2026 08:36:16 for https://mooseframework.inl.gov by doxygen 1.9.8