ADGravity< compute_stage > Class Template Reference

#include <ADGravity.h>

Inheritance diagram for ADGravity< compute_stage >:

Public Member Functions
	ADGravity (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
ADReal	precomputeQpResidual () override

Private Member Functions
const	ADMaterialProperty (Real) &_density

Private Attributes
const Real	_value
const Real	_alpha
	usingKernelValueMembers

Detailed Description

template<ComputeStage compute_stage>
class ADGravity< compute_stage >

Definition at line 15 of file ADGravity.h.

Constructor & Destructor Documentation

ADGravity()

template<ComputeStage compute_stage>

ADGravity< compute_stage >::ADGravity

(

const InputParameters &

parameters

)

Definition at line 34 of file ADGravity.C.

  : ADKernelValue<compute_stage>(parameters),
    _density(getADMaterialProperty<Real>("density")),
    _value(getParam<Real>("value")),
    _alpha(getParam<Real>("alpha"))
{
}

Member Function Documentation

ADMaterialProperty()

template<ComputeStage compute_stage>

const ADGravity< compute_stage >::ADMaterialProperty ( Real  ) &

private

precomputeQpResidual()

template<ComputeStage compute_stage>

ADReal ADGravity< compute_stage >::precomputeQpResidual ( )

overrideprotected

Definition at line 44 of file ADGravity.C.

{
  return -_density[_qp] * _value;
}

validParams()

template<ComputeStage compute_stage>

InputParameters ADGravity< compute_stage >::validParams ( )

static

Definition at line 22 of file ADGravity.C.

{
  InputParameters params = ADKernelValue<compute_stage>::validParams();
  params.addClassDescription("Apply gravity. Value is in units of acceleration.");
  params.addParam<bool>("use_displaced_mesh", true, "Displaced mesh defaults to true");
  params.addRequiredParam<Real>(
      "value", "Value multiplied against the residual, e.g. gravitational acceleration");
  params.addParam<Real>("alpha", 0.0, "alpha parameter required for HHT time integration scheme");
  return params;
}

Member Data Documentation

_alpha

template<ComputeStage compute_stage>

const Real ADGravity< compute_stage >::_alpha

private

Definition at line 36 of file ADGravity.h.

_value

template<ComputeStage compute_stage>

const Real ADGravity< compute_stage >::_value

private

Definition at line 33 of file ADGravity.h.

usingKernelValueMembers

template<ComputeStage compute_stage>

ADGravity< compute_stage >::usingKernelValueMembers

private

Definition at line 38 of file ADGravity.h.

---

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

• tensor_mechanics/include/kernels/ADGravity.h
• tensor_mechanics/src/kernels/ADGravity.C