MaterialDerivativeStdVectorRealTestKernel Class Reference

Kernel for testing derivatives of a std::vector<Real> material property. More...

#include <MaterialDerivativeStdVectorRealTestKernel.h>

Inheritance diagram for MaterialDerivativeStdVectorRealTestKernel:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	MaterialDerivativeStdVectorRealTestKernel (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 () override
virtual Real	computeQpJacobian () override
virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override

Protected Attributes
const unsigned int	_n_vars
	number of nonlinear variables
const std::string &	_name
const MaterialProperty< Real > &	_p
	material property for which to test derivatives
std::vector< const MaterialProperty< std::vector< Real > > * >	_p_off_diag_derivatives
	material properties for the off-diagonal derivatives of the tested property
const MaterialProperty< std::vector< Real > > &	_p_diag_derivative
	material property for the diagonal derivative of the tested property
const unsigned int	_component_i
	the component of the std::vector material property

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

Kernel for testing derivatives of a std::vector<Real> material property.

Definition at line 19 of file MaterialDerivativeStdVectorRealTestKernel.h.

Constructor & Destructor Documentation

MaterialDerivativeStdVectorRealTestKernel()

MaterialDerivativeStdVectorRealTestKernel::MaterialDerivativeStdVectorRealTestKernel

(

const InputParameters &

parameters

)

Definition at line 27 of file MaterialDerivativeStdVectorRealTestKernel.C.

  : DerivativeMaterialInterface<JvarMapKernelInterface<Kernel>>(parameters),
    _n_vars(_coupled_moose_vars.size()),
    _name(getParam<MaterialPropertyName>("material_property")),
    _p(getMaterialProperty<Real>(_name)),
    _p_off_diag_derivatives(_n_vars),
    _p_diag_derivative(
        getMaterialPropertyDerivative<std::vector<Real>>(_name, VariableName(_var.name()))),
    _component_i(getParam<unsigned int>("i"))
{
  for (unsigned int m = 0; m < _n_vars; ++m)
    _p_off_diag_derivatives[m] = &getMaterialPropertyDerivative<std::vector<Real>>(
        _name, VariableName(_coupled_moose_vars[m]->name()));
}

Member Function Documentation

computeQpJacobian()

Real MaterialDerivativeStdVectorRealTestKernel::computeQpJacobian ( )

overrideprotectedvirtual

Definition at line 54 of file MaterialDerivativeStdVectorRealTestKernel.C.

{
  if (_p_diag_derivative[_qp].size() > 0)
    return _p_diag_derivative[_qp][_component_i] * _phi[_j][_qp] * _test[_i][_qp];
  else
    return 0;
}

computeQpOffDiagJacobian()

Real MaterialDerivativeStdVectorRealTestKernel::computeQpOffDiagJacobian ( unsigned int  jvar )

overrideprotectedvirtual

Definition at line 63 of file MaterialDerivativeStdVectorRealTestKernel.C.

{
  // get the coupled variable number corresponding to jvar
  const unsigned int cvar = mapJvarToCvar(jvar);
  if ((*_p_off_diag_derivatives[cvar])[_qp].size() > 0)
    return (*_p_off_diag_derivatives[cvar])[_qp][_component_i] * _phi[_j][_qp] * _test[_i][_qp];
  else
    return 0;
}

computeQpResidual()

Real MaterialDerivativeStdVectorRealTestKernel::computeQpResidual ( )

overrideprotectedvirtual

Definition at line 44 of file MaterialDerivativeStdVectorRealTestKernel.C.

{
  // This would be normally _p[_qp] * _test[_i][_qp];
  // But this kernel sits on a variable where another kernel with Real-valued
  // derivatives is. Our residual then must be 0, becuase we want to contribute
  // with just jacobians without modifying the residual
  return 0;
}

validParams()

InputParameters MaterialDerivativeStdVectorRealTestKernel::validParams ( )

static

Definition at line 15 of file MaterialDerivativeStdVectorRealTestKernel.C.

{
  InputParameters params = Kernel::validParams();
  params.addClassDescription(
      "Class used for testing derivatives of a std::vector<Real> material property.");
  params.addRequiredParam<MaterialPropertyName>(
      "material_property", "Name of material property for which derivatives are to be tested.");
  params.addRequiredCoupledVar("args", "List of variables the material property depends on");
  params.addRequiredParam<unsigned int>("i", "std::vector component");
  return params;
}

Member Data Documentation

_component_i

const unsigned int MaterialDerivativeStdVectorRealTestKernel::_component_i

protected

the component of the std::vector material property

Definition at line 45 of file MaterialDerivativeStdVectorRealTestKernel.h.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

_n_vars

const unsigned int MaterialDerivativeStdVectorRealTestKernel::_n_vars

protected

number of nonlinear variables

Definition at line 31 of file MaterialDerivativeStdVectorRealTestKernel.h.

Referenced by MaterialDerivativeStdVectorRealTestKernel().

_name

const std::string& MaterialDerivativeStdVectorRealTestKernel::_name

protected

Definition at line 33 of file MaterialDerivativeStdVectorRealTestKernel.h.

Referenced by MaterialDerivativeStdVectorRealTestKernel().

_p

const MaterialProperty<Real>& MaterialDerivativeStdVectorRealTestKernel::_p

protected

material property for which to test derivatives

Definition at line 36 of file MaterialDerivativeStdVectorRealTestKernel.h.

_p_diag_derivative

const MaterialProperty<std::vector<Real> >& MaterialDerivativeStdVectorRealTestKernel::_p_diag_derivative

protected

material property for the diagonal derivative of the tested property

Definition at line 42 of file MaterialDerivativeStdVectorRealTestKernel.h.

Referenced by computeQpJacobian().

_p_off_diag_derivatives

std::vector<const MaterialProperty<std::vector<Real> > *> MaterialDerivativeStdVectorRealTestKernel::_p_off_diag_derivatives

protected

material properties for the off-diagonal derivatives of the tested property

Definition at line 39 of file MaterialDerivativeStdVectorRealTestKernel.h.

Referenced by computeQpOffDiagJacobian(), and MaterialDerivativeStdVectorRealTestKernel().

---

The documentation for this class was generated from the following files:

• thermal_hydraulics/test/include/kernels/MaterialDerivativeStdVectorRealTestKernel.h
• thermal_hydraulics/test/src/kernels/MaterialDerivativeStdVectorRealTestKernel.C