GravityVectorInterface Class Reference

Interface for specifying gravity vector. More...

#include <GravityVectorInterface.h>

Inheritance diagram for GravityVectorInterface:

Public Member Functions
	GravityVectorInterface (const MooseObject *moose_object)
Real	gravityMagnitude () const
	Gets gravity magnitude. More...
const RealVectorValue &	gravityVector () const
	Gets gravity magnitude. More...
const RealVectorValue &	gravityDirection () const
	Gets gravity direction (zero vector if zero magnitude) More...

Static Public Member Functions
static InputParameters	validParams ()

Private Attributes
RealVectorValue	_gravity_vector
	Gravitational acceleration vector. More...
Real	_gravity_magnitude
	Gravitational acceleration magnitude. More...
RealVectorValue	_gravity_direction
	Gravitational acceleration unit direction. More...

Detailed Description

Interface for specifying gravity vector.

Definition at line 18 of file GravityVectorInterface.h.

Constructor & Destructor Documentation

GravityVectorInterface()

GravityVectorInterface::GravityVectorInterface

(

const MooseObject *

moose_object

)

Definition at line 32 of file GravityVectorInterface.C.

{
  if (moose_object->isParamValid("gravity_direction"))
  {
    if (moose_object->isParamValid("gravity_vector"))
      moose_object->paramError(
          "gravity_direction",
          "The parameters 'gravity_vector' and 'gravity_direction' are mutually exclusive.");

    _gravity_magnitude = moose_object->getParam<Real>("gravity_magnitude");

    // Direction is normalized below
    _gravity_direction = moose_object->getParam<RealVectorValue>("gravity_direction");

    // If gravity is zero, direction is the zero vector (which is initial value)
    if (MooseUtils::absoluteFuzzyEqual(_gravity_direction.norm(), 0.0))
    {
      if (!MooseUtils::absoluteFuzzyEqual(_gravity_magnitude, 0.0))
        mooseError("If 'gravity_direction' is zero, then 'gravity_magnitude' must also be zero.");
    }
    else
    {
      // If gravity is zero, direction is the zero vector
      if (MooseUtils::absoluteFuzzyEqual(_gravity_magnitude, 0.0))
        _gravity_direction = RealVectorValue(0, 0, 0);
      else
        _gravity_direction = _gravity_direction.unit();
    }

    _gravity_vector = _gravity_magnitude * _gravity_direction;
  }
  else if (moose_object->isParamValid("gravity_vector"))
  {
    if (moose_object->isParamSetByUser("gravity_magnitude"))
      moose_object->paramError(
          "gravity_magnitude",
          "The parameters 'gravity_vector' and 'gravity_magnitude' are mutually exclusive.");

    _gravity_vector = moose_object->getParam<RealVectorValue>("gravity_vector");
    _gravity_magnitude = _gravity_vector.norm();

    // If gravity is zero, direction is the zero vector
    if (MooseUtils::absoluteFuzzyEqual(_gravity_magnitude, 0.0))
      _gravity_direction = RealVectorValue(0, 0, 0);
    else
      _gravity_direction = _gravity_vector / _gravity_magnitude;
  }
  else
    moose_object->paramError("gravity_vector",
                             "Either 'gravity_vector' or 'gravity_direction' must be specified.");
}

Member Function Documentation

gravityDirection()

const RealVectorValue& GravityVectorInterface::gravityDirection ( ) const

inline

Gets gravity direction (zero vector if zero magnitude)

Definition at line 30 of file GravityVectorInterface.h.

Referenced by TestGravityVectorInterface::getValue().

{ return _gravity_direction; }

gravityMagnitude()

Real GravityVectorInterface::gravityMagnitude ( ) const

inline

Gets gravity magnitude.

Definition at line 26 of file GravityVectorInterface.h.

Referenced by TestGravityVectorInterface::getValue().

{ return _gravity_magnitude; }

gravityVector()

const RealVectorValue& GravityVectorInterface::gravityVector ( ) const

inline

Gets gravity magnitude.

Definition at line 28 of file GravityVectorInterface.h.

Referenced by TestGravityVectorInterface::getValue(), and HydrostaticPressureFunction::value().

{ return _gravity_vector; }

validParams()

InputParameters GravityVectorInterface::validParams ( )

static

Definition at line 16 of file GravityVectorInterface.C.

Referenced by TestGravityVectorInterface::validParams(), and HydrostaticPressureFunction::validParams().

{
  InputParameters params = emptyInputParameters();
  params.addParam<Real>("gravity_magnitude",
                        PhysicalConstants::acceleration_of_gravity,
                        "Magnitude of the gravitational acceleration [m/s^2]");
  params.addParam<RealVectorValue>(
      "gravity_direction",
      "Direction of gravitational acceleration. This will be normalized and multiplied by "
      "'gravity_magnitude'. This parameter is mutually exclusive with 'gravity_vector'.");
  params.addParam<RealVectorValue>("gravity_vector",
                                   "Gravitational acceleration vector [m/s^2]. This parameter is "
                                   "mutually exclusive with 'gravity_direction'.");
  return params;
}

Member Data Documentation

_gravity_direction

RealVectorValue GravityVectorInterface::_gravity_direction

private

Gravitational acceleration unit direction.

Definition at line 38 of file GravityVectorInterface.h.

Referenced by gravityDirection(), and GravityVectorInterface().

_gravity_magnitude

Real GravityVectorInterface::_gravity_magnitude

private

Gravitational acceleration magnitude.

Definition at line 36 of file GravityVectorInterface.h.

Referenced by gravityMagnitude(), and GravityVectorInterface().

_gravity_vector

RealVectorValue GravityVectorInterface::_gravity_vector

private

Gravitational acceleration vector.

Definition at line 34 of file GravityVectorInterface.h.

Referenced by gravityVector(), and GravityVectorInterface().

---

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

• misc/include/interfaces/GravityVectorInterface.h
• misc/src/interfaces/GravityVectorInterface.C