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
CoupledSusceptibilityTimeDerivative Class Reference

This calculates a modified coupled time derivative that multiplies the time derivative of a coupled variable by a function of the variables. More...

#include <CoupledSusceptibilityTimeDerivative.h>

Inheritance diagram for CoupledSusceptibilityTimeDerivative:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 CoupledSusceptibilityTimeDerivative (const InputParameters &parameters)
 
virtual void initialSetup ()
 
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 jvar)
 

Protected Attributes

const MaterialProperty< Real > & _F
 The function multiplied by the coupled time derivative.
 
const MaterialProperty< Real > & _dFdu
 function derivative w.r.t. the kernel variable
 
std::vector< const MaterialProperty< Real > * > _dFdarg
 function derivatives w.r.t. coupled variables
 

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

This calculates a modified coupled time derivative that multiplies the time derivative of a coupled variable by a function of the variables.

Definition at line 21 of file CoupledSusceptibilityTimeDerivative.h.

Constructor & Destructor Documentation

◆ CoupledSusceptibilityTimeDerivative()

CoupledSusceptibilityTimeDerivative::CoupledSusceptibilityTimeDerivative ( const InputParameters &  parameters)

Definition at line 25 of file CoupledSusceptibilityTimeDerivative.C.

27 : DerivativeMaterialInterface<JvarMapKernelInterface<CoupledTimeDerivative>>(parameters),
28 _F(getMaterialProperty<Real>("f_name")),
29 _dFdu(getMaterialPropertyDerivative<Real>("f_name", _var.name())),
30 _dFdarg(_n_args)
31{
32 // fetch derivatives
33 for (unsigned int i = 0; i < _n_args; ++i)
34 _dFdarg[i] = &getMaterialPropertyDerivative<Real>("f_name", i);
35}
CoupledSusceptibilityTimeDerivative::_dFdarg
std::vector< const MaterialProperty< Real > * > _dFdarg
function derivatives w.r.t. coupled variables
Definition CoupledSusceptibilityTimeDerivative.h:42
CoupledSusceptibilityTimeDerivative::_F
const MaterialProperty< Real > & _F
The function multiplied by the coupled time derivative.
Definition CoupledSusceptibilityTimeDerivative.h:36
CoupledSusceptibilityTimeDerivative::_dFdu
const MaterialProperty< Real > & _dFdu
function derivative w.r.t. the kernel variable
Definition CoupledSusceptibilityTimeDerivative.h:39

Member Function Documentation

◆ computeQpJacobian()

Real CoupledSusceptibilityTimeDerivative::computeQpJacobian ( )
protectedvirtual

Reimplemented in AntitrappingCurrent.

Definition at line 50 of file CoupledSusceptibilityTimeDerivative.C.

51{
52 return CoupledTimeDerivative::computeQpResidual() * _dFdu[_qp] * _phi[_j][_qp];
53}
CoupledTimeDerivative::computeQpResidual
virtual Real computeQpResidual() override

◆ computeQpOffDiagJacobian()

Real CoupledSusceptibilityTimeDerivative::computeQpOffDiagJacobian ( unsigned int  jvar)
protectedvirtual

Reimplemented in AntitrappingCurrent.

Definition at line 56 of file CoupledSusceptibilityTimeDerivative.C.

57{
58 // get the coupled variable jvar is referring to
59 const unsigned int cvar = mapJvarToCvar(jvar);
60
61 if (jvar == _v_var)
62 return CoupledTimeDerivative::computeQpOffDiagJacobian(jvar) * _F[_qp] +
63 CoupledTimeDerivative::computeQpResidual() * _phi[_j][_qp] * (*_dFdarg[cvar])[_qp];
64
65 return CoupledTimeDerivative::computeQpResidual() * _phi[_j][_qp] * (*_dFdarg[cvar])[_qp];
66}
CoupledTimeDerivative::computeQpOffDiagJacobian
virtual Real computeQpOffDiagJacobian(unsigned int jvar) override

◆ computeQpResidual()

Real CoupledSusceptibilityTimeDerivative::computeQpResidual ( )
protectedvirtual

Reimplemented in AntitrappingCurrent.

Definition at line 44 of file CoupledSusceptibilityTimeDerivative.C.

45{
46 return CoupledTimeDerivative::computeQpResidual() * _F[_qp];
47}

◆ initialSetup()

void CoupledSusceptibilityTimeDerivative::initialSetup ( )
virtual

Definition at line 38 of file CoupledSusceptibilityTimeDerivative.C.

39{
40 validateNonlinearCoupling<Real>("f_name");
41}

◆ validParams()

InputParameters CoupledSusceptibilityTimeDerivative::validParams ( )
static

Definition at line 15 of file CoupledSusceptibilityTimeDerivative.C.

16{
17 InputParameters params = JvarMapKernelInterface<CoupledTimeDerivative>::validParams();
18 params.addClassDescription("A modified coupled time derivative Kernel that multiplies the time "
19 "derivative of a coupled variable by a generalized susceptibility");
20 params.addRequiredParam<MaterialPropertyName>(
21 "f_name", "Susceptibility function F defined in a FunctionMaterial");
22 return params;
23}
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
JvarMapKernelInterface::validParams
static InputParameters validParams()

Referenced by AntitrappingCurrent::validParams().

Member Data Documentation

◆ _dFdarg

std::vector<const MaterialProperty<Real> *> CoupledSusceptibilityTimeDerivative::_dFdarg
protected

function derivatives w.r.t. coupled variables

Definition at line 42 of file CoupledSusceptibilityTimeDerivative.h.

Referenced by AntitrappingCurrent::computeQpOffDiagJacobian(), computeQpOffDiagJacobian(), and CoupledSusceptibilityTimeDerivative().

◆ _dFdu

const MaterialProperty<Real>& CoupledSusceptibilityTimeDerivative::_dFdu
protected

function derivative w.r.t. the kernel variable

Definition at line 39 of file CoupledSusceptibilityTimeDerivative.h.

Referenced by AntitrappingCurrent::computeQpJacobian(), and computeQpJacobian().

◆ _F

const MaterialProperty<Real>& CoupledSusceptibilityTimeDerivative::_F
protected

The function multiplied by the coupled time derivative.

Definition at line 36 of file CoupledSusceptibilityTimeDerivative.h.

Referenced by AntitrappingCurrent::computeQpOffDiagJacobian(), computeQpOffDiagJacobian(), AntitrappingCurrent::computeQpResidual(), and computeQpResidual().

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:42:34 for https://mooseframework.inl.gov by doxygen 1.9.8