GravityInterface Class Reference

Interface for specifying gravity at the component level. More...

#include <GravityInterface.h>

Inheritance diagram for GravityInterface:

Public Member Functions
	GravityInterface (const InputParameters &parameters)
Real	getGravityMagnitude () const
	Gets gravity magnitude.

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const RealVectorValue &	_gravity_vector
	Gravitational acceleration vector.
const Real	_gravity_magnitude
	Gravitational acceleration magnitude.
const bool	_gravity_is_zero
	Gravitational acceleration magnitude is zero?
const RealVectorValue	_gravity_direction
	Gravitational acceleration unit direction.

Detailed Description

Interface for specifying gravity at the component level.

Definition at line 18 of file GravityInterface.h.

Constructor & Destructor Documentation

GravityInterface()

GravityInterface::GravityInterface

(

const InputParameters &

parameters

)

Definition at line 23 of file GravityInterface.C.

  : _gravity_vector(parameters.get<RealVectorValue>("gravity_vector")),
    _gravity_magnitude(_gravity_vector.norm()),
    _gravity_is_zero(MooseUtils::absoluteFuzzyEqual(_gravity_magnitude, 0.0)),
    _gravity_direction(_gravity_is_zero ? RealVectorValue(0.0, 0.0, 0.0) : _gravity_vector.unit())
{
}

Member Function Documentation

getGravityMagnitude()

Real GravityInterface::getGravityMagnitude ( ) const

inline

Gets gravity magnitude.

Definition at line 26 of file GravityInterface.h.

{ return _gravity_magnitude; }

validParams()

InputParameters GravityInterface::validParams ( )

static

Definition at line 15 of file GravityInterface.C.

{
  InputParameters params = emptyInputParameters();
  params.addParam<RealVectorValue>(
      "gravity_vector", THM::default_gravity_vector, "Gravitational acceleration vector [m/s^2]");
  return params;
}

Referenced by FlowChannelBase::validParams().

Member Data Documentation

_gravity_direction

const RealVectorValue GravityInterface::_gravity_direction

protected

Gravitational acceleration unit direction.

Definition at line 36 of file GravityInterface.h.

_gravity_is_zero

const bool GravityInterface::_gravity_is_zero

protected

Gravitational acceleration magnitude is zero?

Definition at line 34 of file GravityInterface.h.

_gravity_magnitude

const Real GravityInterface::_gravity_magnitude

protected

Gravitational acceleration magnitude.

Definition at line 32 of file GravityInterface.h.

Referenced by getGravityMagnitude().

_gravity_vector

const RealVectorValue& GravityInterface::_gravity_vector

protected

Gravitational acceleration vector.

Definition at line 30 of file GravityInterface.h.

---

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

• thermal_hydraulics/include/interfaces/GravityInterface.h
• thermal_hydraulics/src/interfaces/GravityInterface.C