#include <InertialForce.h>

Inheritance diagram for InertialForceTempl< is_ad >:

Public Member Functions
	InertialForceTempl (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

static std::pair< GenericReal< is_ad >, GenericReal< is_ad > >	computeNewmarkBetaVelAccel (const GenericReal< is_ad > &u, const Real u_old, const Real vel_old, const Real accel_old, const Real beta, const Real gamma, const Real dt)

Protected Member Functions
virtual GenericReal< is_ad >	computeQpResidual ()

virtual Real	computeQpJacobian ()

virtual void	computeResidualAdditional ()

void	computeResidualAdditional ()

void	computeResidualAdditional ()

Real	computeQpJacobian ()

Real	computeQpJacobian ()

Private Attributes
const GenericMaterialProperty< Real, is_ad > &	_density

const VariableValue *	_u_old

const VariableValue *	_vel_old

const VariableValue *	_accel_old

const bool	_has_beta

const bool	_has_gamma

const Real	_beta

const Real	_gamma

const bool	_has_velocity

const bool	_has_acceleration

const GenericMaterialProperty< Real, is_ad > &	_eta

const MaterialProperty< Real > &	_density_scaling

const Real	_alpha

const VariableValue *	_u_dot_factor_dof

const VariableValue *	_u_dotdot_factor_dof

const VariableValue *	_u_dot_factor

const VariableValue *	_u_dotdot_factor

const VariableValue *	_u_dot_old

const VariableValue *	_du_dot_du

const VariableValue *	_du_dotdot_du

const TimeIntegrator &	_time_integrator
	The TimeIntegrator.

Detailed Description

template<bool is_ad>
class InertialForceTempl< is_ad >

Definition at line 24 of file InertialForce.h.

Constructor & Destructor Documentation

◆ InertialForceTempl()

template<bool is_ad>

InertialForceTempl< is_ad >::InertialForceTempl ( const InputParameters & parameters )

Definition at line 52 of file InertialForce.C.

  : InertialForceParent<is_ad>(parameters),
    _density(this->template getGenericMaterialProperty<Real, is_ad>("density")),
    _has_beta(this->isParamValid("beta")),
    _has_gamma(this->isParamValid("gamma")),
    _beta(_has_beta ? this->template getParam<Real>("beta") : 0.1),
    _gamma(_has_gamma ? this->template getParam<Real>("gamma") : 0.1),
    _has_velocity(this->isParamValid("velocity")),
    _has_acceleration(this->isParamValid("acceleration")),
    _eta(this->template getGenericMaterialProperty<Real, is_ad>("eta")),
    _density_scaling(this->template getMaterialProperty<Real>("density_scaling")),
    _alpha(this->template getParam<Real>("alpha")),
    _time_integrator(_sys.getTimeIntegrator(this->_var.number()))
{
  if (_has_beta && _has_gamma && _has_velocity && _has_acceleration)
  {
    _vel_old = &this->coupledValueOld("velocity");
    _accel_old = &this->coupledValueOld("acceleration");
    _u_old = &this->valueOld();
  }
  else if (!_has_beta && !_has_gamma && !_has_velocity && !_has_acceleration)
  {
    _u_dot_old = &(_var.uDotOld());
    _du_dot_du = &(_var.duDotDu());
    _du_dotdot_du = &(_var.duDotDotDu());
 
    this->addFEVariableCoupleableVectorTag(_time_integrator.uDotFactorTag());
    this->addFEVariableCoupleableVectorTag(_time_integrator.uDotDotFactorTag());
 
    _u_dot_factor = &_var.vectorTagValue(_time_integrator.uDotFactorTag());
    _u_dotdot_factor = &_var.vectorTagValue(_time_integrator.uDotDotFactorTag());
 
    if (_time_integrator.isLumped())
    {
      _u_dot_factor_dof = &_var.vectorTagDofValue(_time_integrator.uDotFactorTag());
      _u_dotdot_factor_dof = &_var.vectorTagDofValue(_time_integrator.uDotDotFactorTag());
    }
  }
  else
    mooseError("InertialForce: Either all or none of `beta`, `gamma`, `velocity`and `acceleration` "
               "should be provided as input.");
 
  // Check if HHT and explicit are being used simultaneously
  if (_alpha != 0 && _time_integrator.isExplicit())
    mooseError("InertialForce: HHT time integration parameter can only be used with Newmark-Beta "
               "time integration.");
 
  // Check if beta and explicit are being used simultaneously
  if (_has_beta && _time_integrator.isExplicit())
    mooseError("InertialForce: Newmark-beta integration parameter, beta, cannot be provided along "
               "with an explicit time "
               "integrator.");
 
  if (!(_time_integrator.isLumped() && _time_integrator.isExplicit()))
    if (parameters.isParamSetByUser("density_scaling"))
      this->paramError(
          "density_scaling",
          "Density (mass) scaling can only be used in lumped mass, explicit simulations");
}

Member Function Documentation

◆ computeNewmarkBetaVelAccel()

template<bool is_ad>

std::pair< GenericReal< is_ad >, GenericReal< is_ad > > InertialForceTempl< is_ad >::computeNewmarkBetaVelAccel	(	const GenericReal< is_ad > &	u,
		const Real	u_old,
		const Real	vel_old,
		const Real	accel_old,
		const Real	beta,
		const Real	gamma,
		const Real	dt
	)

static

Definition at line 114 of file InertialForce.C.

{
  const auto accel =
      1.0 / beta * (((u - u_old) / (dt * dt)) - vel_old / dt - accel_old * (0.5 - beta));
  const auto vel = vel_old + (dt * (1.0 - gamma)) * accel_old + gamma * dt * accel;
  return {vel, accel};
}

Referenced by ADPenaltyVelocityContinuityNewmarkBeta::solidVelocity().

◆ computeQpJacobian() [1/3]

template<bool is_ad>

virtual Real InertialForceTempl< is_ad >::computeQpJacobian ( )

protectedvirtual

◆ computeQpJacobian() [2/3]

Real InertialForceTempl< true >::computeQpJacobian ( )

protected

Definition at line 181 of file InertialForce.C.

{
  mooseError("Internal error");
}

◆ computeQpJacobian() [3/3]

Real InertialForceTempl< false >::computeQpJacobian ( )

protected

Definition at line 188 of file InertialForce.C.

{
  if (_dt == 0)
    return 0;
  else
  {
    if (_has_beta)
      return _test[_i][_qp] * _density[_qp] / (_beta * _dt * _dt) * _phi[this->_j][_qp] +
             _eta[_qp] * (1 + _alpha) * _test[_i][_qp] * _density[_qp] * _gamma / _beta / _dt *
                 _phi[this->_j][_qp];
    else
      return _test[_i][_qp] * _density[_qp] * (*_du_dotdot_du)[_qp] * _phi[this->_j][_qp] +
             _eta[_qp] * (1 + _alpha) * _test[_i][_qp] * _density[_qp] * (*_du_dot_du)[_qp] *
                 _phi[this->_j][_qp];
  }
}

◆ computeQpResidual()

template<bool is_ad>

GenericReal< is_ad > InertialForceTempl< is_ad >::computeQpResidual ( )

protectedvirtual

Definition at line 130 of file InertialForce.C.

{
  if (_dt == 0)
    return 0;
  else if (_has_beta)
  {
    const auto [vel, accel] = computeNewmarkBetaVelAccel(
        _u[_qp], (*_u_old)[_qp], (*_vel_old)[_qp], (*_accel_old)[_qp], _beta, _gamma, _dt);
    return _test[_i][_qp] * _density[_qp] *
           (accel + vel * _eta[_qp] * (1.0 + _alpha) - _alpha * _eta[_qp] * (*_vel_old)[_qp]);
  }
 
  // Lumped mass option
  // Only lumping the masses here
  // will multiply by corresponding residual multiplier after lumping the matrix
  // Density scaling is a fictitious added density to increase the time step
  else if (_time_integrator.isLumped() && _time_integrator.isExplicit() && !is_ad)
    return _test[_i][_qp] * (_density[_qp] + _density_scaling[_qp]);
 
  // Consistent mass option
  // Same for explicit, implicit, and implicit with HHT
  else
    return _test[_i][_qp] * _density[_qp] *
           ((*_u_dotdot_factor)[_qp] + (*_u_dot_factor)[_qp] * _eta[_qp] * (1.0 + _alpha) -
            _alpha * _eta[_qp] * (*_u_dot_old)[_qp]);
}

◆ computeResidualAdditional() [1/3]

template<bool is_ad>

virtual void InertialForceTempl< is_ad >::computeResidualAdditional ( )

protectedvirtual

◆ computeResidualAdditional() [2/3]

void InertialForceTempl< true >::computeResidualAdditional ( )

protected

Definition at line 159 of file InertialForce.C.

{
  mooseError("Internal error");
}

◆ computeResidualAdditional() [3/3]

void InertialForceTempl< false >::computeResidualAdditional ( )

protected

Definition at line 166 of file InertialForce.C.

{
  if (_dt == 0)
    return;
 
  // Explicit lumped only
  if (!_time_integrator.isLumped() || !_time_integrator.isExplicit())
    return;
 
  for (unsigned int i = 0; i < _test.size(); ++i)
    this->_local_re(i) *= (*_u_dotdot_factor_dof)[i] + _eta[0] * (*_u_dot_factor_dof)[i];
}

◆ validParams()

template<bool is_ad>

InputParameters InertialForceTempl< is_ad >::validParams ( )

static

Definition at line 20 of file InertialForce.C.

{
  InputParameters params = InertialForceParent<is_ad>::validParams();
  params.addClassDescription("Calculates the residual for the inertial force "
                             "($M \\cdot acceleration$) and the contribution of mass"
                             " dependent Rayleigh damping and HHT time "
                             " integration scheme ($\\eta \\cdot M \\cdot"
                             " ((1+\\alpha)velq2-\\alpha \\cdot vel-old) $)");
  params.set<bool>("use_displaced_mesh") = true;
  params.addCoupledVar("velocity", "velocity variable");
  params.addCoupledVar("acceleration", "acceleration variable");
  params.addParam<Real>("beta", "beta parameter for Newmark Time integration");
  params.addParam<Real>("gamma", "gamma parameter for Newmark Time integration");
  params.addParam<MaterialPropertyName>("eta",
                                        0.0,
                                        "Name of material property or a constant real "
                                        "number defining the eta parameter for the "
                                        "Rayleigh damping.");
  params.addParam<MaterialPropertyName>(
      "density_scaling",
      0.0,
      "Name of material property to add mass scaling in explicit simulations.");
  params.addParam<Real>("alpha",
                        0,
                        "alpha parameter for mass dependent numerical damping induced "
                        "by HHT time integration scheme");
  params.addParam<MaterialPropertyName>(
      "density", "density", "Name of Material Property that provides the density");
  return params;
}

Member Data Documentation

◆ _accel_old

template<bool is_ad>

const VariableValue* InertialForceTempl< is_ad >::_accel_old

private

Definition at line 51 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _alpha

template<bool is_ad>

const Real InertialForceTempl< is_ad >::_alpha

private

Definition at line 60 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _beta

template<bool is_ad>

const Real InertialForceTempl< is_ad >::_beta

private

Definition at line 54 of file InertialForce.h.

◆ _density

template<bool is_ad>

const GenericMaterialProperty<Real, is_ad>& InertialForceTempl< is_ad >::_density

private

Definition at line 48 of file InertialForce.h.

◆ _density_scaling

template<bool is_ad>

const MaterialProperty<Real>& InertialForceTempl< is_ad >::_density_scaling

private

Definition at line 59 of file InertialForce.h.

◆ _du_dot_du

template<bool is_ad>

const VariableValue* InertialForceTempl< is_ad >::_du_dot_du

private

Definition at line 68 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _du_dotdot_du

template<bool is_ad>

const VariableValue* InertialForceTempl< is_ad >::_du_dotdot_du

private

Definition at line 69 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _eta

template<bool is_ad>

const GenericMaterialProperty<Real, is_ad>& InertialForceTempl< is_ad >::_eta

private

Definition at line 58 of file InertialForce.h.

◆ _gamma

template<bool is_ad>

const Real InertialForceTempl< is_ad >::_gamma

private

Definition at line 55 of file InertialForce.h.

◆ _has_acceleration

template<bool is_ad>

const bool InertialForceTempl< is_ad >::_has_acceleration

private

Definition at line 57 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _has_beta

template<bool is_ad>

const bool InertialForceTempl< is_ad >::_has_beta

private

Definition at line 52 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _has_gamma

template<bool is_ad>

const bool InertialForceTempl< is_ad >::_has_gamma

private

Definition at line 53 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _has_velocity

template<bool is_ad>

const bool InertialForceTempl< is_ad >::_has_velocity

private

Definition at line 56 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _time_integrator

template<bool is_ad>

const TimeIntegrator& InertialForceTempl< is_ad >::_time_integrator

private

The TimeIntegrator.

Definition at line 72 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _u_dot_factor

template<bool is_ad>

const VariableValue* InertialForceTempl< is_ad >::_u_dot_factor

private

Definition at line 65 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _u_dot_factor_dof

template<bool is_ad>

const VariableValue* InertialForceTempl< is_ad >::_u_dot_factor_dof

private

Definition at line 63 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _u_dot_old

template<bool is_ad>

const VariableValue* InertialForceTempl< is_ad >::_u_dot_old

private

Definition at line 67 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _u_dotdot_factor

template<bool is_ad>

const VariableValue* InertialForceTempl< is_ad >::_u_dotdot_factor

private

Definition at line 66 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _u_dotdot_factor_dof

template<bool is_ad>

const VariableValue* InertialForceTempl< is_ad >::_u_dotdot_factor_dof

private

Definition at line 64 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _u_old

template<bool is_ad>

const VariableValue* InertialForceTempl< is_ad >::_u_old

private

Definition at line 49 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

◆ _vel_old

template<bool is_ad>

const VariableValue* InertialForceTempl< is_ad >::_vel_old

private

Definition at line 50 of file InertialForce.h.

Referenced by InertialForceTempl< is_ad >::InertialForceTempl().

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

solid_mechanics/include/kernels/InertialForce.h
solid_mechanics/src/kernels/InertialForce.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ InertialForceTempl()

Member Function Documentation

◆ computeNewmarkBetaVelAccel()

◆ computeQpJacobian() [1/3]

◆ computeQpJacobian() [2/3]

◆ computeQpJacobian() [3/3]

◆ computeQpResidual()

◆ computeResidualAdditional() [1/3]

◆ computeResidualAdditional() [2/3]

◆ computeResidualAdditional() [3/3]

◆ validParams()

Member Data Documentation

◆ _accel_old

◆ _alpha

◆ _beta

◆ _density

◆ _density_scaling

◆ _du_dot_du

◆ _du_dotdot_du

◆ _eta

◆ _gamma

◆ _has_acceleration

◆ _has_beta

◆ _has_gamma

◆ _has_velocity

◆ _time_integrator

◆ _u_dot_factor

◆ _u_dot_factor_dof

◆ _u_dot_old

◆ _u_dotdot_factor

◆ _u_dotdot_factor_dof

◆ _u_old

◆ _vel_old