Gravity Class Reference

Gravity computes the body force (force/volume) given the acceleration of gravity (value) and the density. More...

#include <Gravity.h>

Inheritance diagram for Gravity:

Public Member Functions
	Gravity (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeQpResidual ()

Protected Attributes
const MaterialProperty< Real > &	_density
const Real	_value
const Function &	_function
const Real	_alpha

Detailed Description

Gravity computes the body force (force/volume) given the acceleration of gravity (value) and the density.

Definition at line 24 of file Gravity.h.

Constructor & Destructor Documentation

Gravity()

Gravity::Gravity

(

const InputParameters &

parameters

)

Definition at line 31 of file Gravity.C.

  : Kernel(parameters),
    _density(getMaterialProperty<Real>("density")),
    _value(getParam<Real>("value")),
    _function(getFunction("function")),
    _alpha(getParam<Real>("alpha"))
{
}

Member Function Documentation

computeQpResidual()

Real Gravity::computeQpResidual ( )

protectedvirtual

Definition at line 41 of file Gravity.C.

{
  Real factor = _value * _function.value(_t + _alpha * _dt, _q_point[_qp]);
  return _density[_qp] * _test[_i][_qp] * -factor;
}

validParams()

InputParameters Gravity::validParams ( )

static

Definition at line 18 of file Gravity.C.

{
  InputParameters params = Kernel::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<FunctionName>(
      "function", "1", "A function that describes the gravitational force");
  params.addParam<Real>("alpha", 0.0, "alpha parameter required for HHT time integration scheme");
  return params;
}

Member Data Documentation

_alpha

const Real Gravity::_alpha

protected

Definition at line 39 of file Gravity.h.

Referenced by computeQpResidual().

_density

const MaterialProperty<Real>& Gravity::_density

protected

Definition at line 34 of file Gravity.h.

Referenced by computeQpResidual().

_function

const Function& Gravity::_function

protected

Definition at line 36 of file Gravity.h.

Referenced by computeQpResidual().

_value

const Real Gravity::_value

protected

Definition at line 35 of file Gravity.h.

Referenced by computeQpResidual().

---

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

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