www.mooseframework.org
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected 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. More...
 
const MaterialProperty< Real > & _dFdu
 function derivative w.r.t. the kernel variable More...
 
std::vector< const MaterialProperty< Real > * > _dFdarg
 function derivatives w.r.t. coupled variables More...
 

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.

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

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 }
virtual Real computeQpResidual() override
const MaterialProperty< Real > & _dFdu
function derivative w.r.t. the kernel variable

◆ 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)
63  CoupledTimeDerivative::computeQpResidual() * _phi[_j][_qp] * (*_dFdarg[cvar])[_qp];
64 
65  return CoupledTimeDerivative::computeQpResidual() * _phi[_j][_qp] * (*_dFdarg[cvar])[_qp];
66 }
std::vector< const MaterialProperty< Real > * > _dFdarg
function derivatives w.r.t. coupled variables
virtual Real computeQpResidual() override
virtual Real computeQpOffDiagJacobian(unsigned int jvar) override
const MaterialProperty< Real > & _F
The function multiplied by the coupled time derivative.

◆ computeQpResidual()

Real CoupledSusceptibilityTimeDerivative::computeQpResidual ( )
protectedvirtual

Reimplemented in AntitrappingCurrent.

Definition at line 44 of file CoupledSusceptibilityTimeDerivative.C.

45 {
47 }
virtual Real computeQpResidual() override
const MaterialProperty< Real > & _F
The function multiplied by the coupled time derivative.

◆ 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.

Referenced by AntitrappingCurrent::validParams().

16 {
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 }
void addRequiredParam(const std::string &name, const std::string &doc_string)
static InputParameters validParams()
void addClassDescription(const std::string &doc_string)

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 documentation for this class was generated from the following files: