Base class for implementing DG cohesive zone models (CZM) for 1D,2D, and 3D traction separation laws. More...

#include <CZMInterfaceKernelBase.h>

Inheritance diagram for CZMInterfaceKernelBase:

Public Types
typedef std::vector< int >	JvarMap

Public Member Functions
	CZMInterfaceKernelBase (const InputParameters &parameters)

virtual void	computeOffDiagJacobian (unsigned int jvar) override

unsigned int	mapJvarToCvar (unsigned int jvar)

int	mapJvarToCvar (unsigned int jvar, const JvarMap &jvar_map)

bool	mapJvarToCvar (unsigned int jvar, unsigned int &cvar)

const JvarMap &	getJvarMap ()

const JvarMap &	getParameterJvarMap (std::string parameter_name)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
Real	computeQpResidual (Moose::DGResidualType type) override

Real	computeQpJacobian (Moose::DGJacobianType type) override

Real	computeQpOffDiagJacobian (Moose::DGJacobianType type, unsigned int jvar) override

virtual Real	computeDResidualDDisplacement (const unsigned int &component_j, const Moose::DGJacobianType &type) const =0
	method computing the derivative of residual[_component] w.r.t displacement[component_j]

Protected Attributes
const std::string	_base_name
	Base name of the material system that this kernel applies to.

const unsigned int	_component
	the displacement component this kernel is operating on (0=x, 1=y, 2 =z)

const unsigned int	_ndisp
	number of displacement components

std::vector< MooseVariable * >	_vars

const unsigned int	_n_args


std::vector< unsigned int >	_disp_var
	Coupled displacement component variable IDs.

std::vector< unsigned int >	_disp_neighbor_var


const MaterialProperty< RealVectorValue > &	_traction_global

const MaterialProperty< RankTwoTensor > &	_dtraction_djump_global

Private Attributes
const std::size_t	_jvar_max_size

JvarMap	_jvar_map

std::map< std::string, JvarMap >	_jvar_local_map

Detailed Description

Base class for implementing DG cohesive zone models (CZM) for 1D,2D, and 3D traction separation laws.

This kernel operates only on a single displacement compenent. One kernel is required for each displacement component.

Definition at line 19 of file CZMInterfaceKernelBase.h.

Constructor & Destructor Documentation

◆ CZMInterfaceKernelBase()

CZMInterfaceKernelBase::CZMInterfaceKernelBase ( const InputParameters & parameters )

Definition at line 30 of file CZMInterfaceKernelBase.C.

  : JvarMapKernelInterface<InterfaceKernel>(parameters),
    _base_name(isParamValid("base_name") && !getParam<std::string>("base_name").empty()
                   ? getParam<std::string>("base_name") + "_"
                   : ""),
    _component(getParam<unsigned int>("component")),
    _ndisp(coupledComponents("displacements")),
    _disp_var(_ndisp),
    _disp_neighbor_var(_ndisp),
    _vars(_ndisp),
    _traction_global(getMaterialPropertyByName<RealVectorValue>(
        _base_name + getParam<std::string>("traction_global_name"))),
    _dtraction_djump_global(
        getMaterialPropertyByName<RankTwoTensor>(_base_name + "dtraction_djump_global"))
{
  // Enforce consistency
  if (_ndisp != _mesh.dimension())
    paramError("displacements", "Number of displacements must match problem dimension.");
 
  if (_ndisp > 3 || _ndisp < 1)
    mooseError("the CZM material requires 1, 2 or 3 displacement variables");
 
  for (unsigned int i = 0; i < _ndisp; ++i)
  {
    _disp_var[i] = coupled("displacements", i);
    _disp_neighbor_var[i] = coupled("displacements", i);
    _vars[i] = getVar("displacements", i);
  }
}

Member Function Documentation

◆ computeDResidualDDisplacement()

virtual Real CZMInterfaceKernelBase::computeDResidualDDisplacement	(	const unsigned int &	component_j,
		const Moose::DGJacobianType &	type
	)		const

protectedpure virtual

method computing the derivative of residual[_component] w.r.t displacement[component_j]

Implemented in CZMInterfaceKernelSmallStrain, and CZMInterfaceKernelTotalLagrangian.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

◆ computeQpJacobian()

Real CZMInterfaceKernelBase::computeQpJacobian ( Moose::DGJacobianType type )

overrideprotected

Definition at line 79 of file CZMInterfaceKernelBase.C.

{
  // retrieve the diagonal Jacobian coefficient dependning on the displacement
  // component (_component) this kernel is working on
  return computeDResidualDDisplacement(_component, type);
}

◆ computeQpOffDiagJacobian()

Real CZMInterfaceKernelBase::computeQpOffDiagJacobian	(	Moose::DGJacobianType	type,
		unsigned int	jvar
	)

overrideprotected

Definition at line 87 of file CZMInterfaceKernelBase.C.

{
  // bail out if jvar is not coupled
  if (getJvarMap()[jvar] < 0)
    return 0.0;
 
  // Jacobian of the residul[_component] w.r.t to the coupled displacement
  // component[off_diag_component]
  for (unsigned int off_diag_component = 0; off_diag_component < _ndisp; ++off_diag_component)
  {
    if (jvar == _disp_var[off_diag_component])
      return computeDResidualDDisplacement(off_diag_component, type);
  }
  // this is the place where one should implement derivatives of the residual w.r.t. other variables
  return 0.0;
}

◆ computeQpResidual()

Real CZMInterfaceKernelBase::computeQpResidual ( Moose::DGResidualType type )

overrideprotected

Definition at line 61 of file CZMInterfaceKernelBase.C.

{
  Real r = _traction_global[_qp](_component);
 
  switch (type)
  {
    // [test_secondary-test_primary]*T where T represents the traction.
    case Moose::Element:
      r *= -_test[_i][_qp];
      break;
    case Moose::Neighbor:
      r *= _test_neighbor[_i][_qp];
      break;
  }
  return r;
}

◆ validParams()

InputParameters CZMInterfaceKernelBase::validParams ( )

static

Definition at line 13 of file CZMInterfaceKernelBase.C.

{
  InputParameters params = InterfaceKernel::validParams();
  params.addRequiredParam<unsigned int>("component",
                                        "the component of the "
                                        "displacement vector this kernel is working on:"
                                        " component == 0, ==> X"
                                        " component == 1, ==> Y"
                                        " component == 2, ==> Z");
  params.suppressParameter<bool>("use_displaced_mesh");
  params.addRequiredCoupledVar("displacements", "the string containing displacement variables");
  params.addParam<std::string>("base_name", "Material property base name");
  params.set<std::string>("traction_global_name") = "traction_global";
 
  return params;
}

Referenced by ADCZMInterfaceKernelBase::validParams(), CZMInterfaceKernelSmallStrain::validParams(), and CZMInterfaceKernelTotalLagrangian::validParams().

Member Data Documentation

◆ _base_name

const std::string CZMInterfaceKernelBase::_base_name

protected

Base name of the material system that this kernel applies to.

Definition at line 35 of file CZMInterfaceKernelBase.h.

◆ _component

const unsigned int CZMInterfaceKernelBase::_component

protected

the displacement component this kernel is operating on (0=x, 1=y, 2 =z)

Definition at line 38 of file CZMInterfaceKernelBase.h.

Referenced by CZMInterfaceKernelSmallStrain::computeDResidualDDisplacement(), CZMInterfaceKernelTotalLagrangian::computeDResidualDDisplacement(), computeQpJacobian(), computeQpResidual(), and CZMInterfaceKernelTotalLagrangian::JacLD().

◆ _disp_neighbor_var

std::vector<unsigned int> CZMInterfaceKernelBase::_disp_neighbor_var

protected

Definition at line 46 of file CZMInterfaceKernelBase.h.

Referenced by CZMInterfaceKernelBase().

◆ _disp_var

std::vector<unsigned int> CZMInterfaceKernelBase::_disp_var

protected

Coupled displacement component variable IDs.

Definition at line 45 of file CZMInterfaceKernelBase.h.

Referenced by computeQpOffDiagJacobian(), and CZMInterfaceKernelBase().

◆ _dtraction_djump_global

const MaterialProperty<RankTwoTensor>& CZMInterfaceKernelBase::_dtraction_djump_global

protected

Definition at line 55 of file CZMInterfaceKernelBase.h.

Referenced by CZMInterfaceKernelSmallStrain::computeDResidualDDisplacement(), and CZMInterfaceKernelTotalLagrangian::computeDResidualDDisplacement().

◆ _ndisp

const unsigned int CZMInterfaceKernelBase::_ndisp

protected

number of displacement components

Definition at line 41 of file CZMInterfaceKernelBase.h.

Referenced by computeQpOffDiagJacobian(), and CZMInterfaceKernelBase().

◆ _traction_global

const MaterialProperty<RealVectorValue>& CZMInterfaceKernelBase::_traction_global

protected

Definition at line 54 of file CZMInterfaceKernelBase.h.

Referenced by computeQpResidual().

◆ _vars

std::vector<MooseVariable *> CZMInterfaceKernelBase::_vars

protected

Definition at line 50 of file CZMInterfaceKernelBase.h.

Referenced by CZMInterfaceKernelSmallStrain::computeDResidualDDisplacement(), CZMInterfaceKernelTotalLagrangian::computeDResidualDDisplacement(), CZMInterfaceKernelBase(), and CZMInterfaceKernelTotalLagrangian::JacLD().

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

solid_mechanics/include/interfacekernels/CZMInterfaceKernelBase.h
solid_mechanics/src/interfacekernels/CZMInterfaceKernelBase.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CZMInterfaceKernelBase()

Member Function Documentation

◆ computeDResidualDDisplacement()

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ validParams()

Member Data Documentation

◆ _base_name

◆ _component

◆ _disp_neighbor_var

◆ _disp_var

◆ _dtraction_djump_global

◆ _ndisp

◆ _traction_global

◆ _vars