https://mooseframework.inl.gov
Loading...
Searching...
No Matches
GravityVectorInterface.h
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
3//*
4//* All rights reserved, see COPYRIGHT for full restrictions
5//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6//*
7//* Licensed under LGPL 2.1, please see LICENSE for details
8//* https://www.gnu.org/licenses/lgpl-2.1.html
9
10#pragma once
11
12#include "InputParameters.h"
13#include "libmesh/vector_value.h"
14
19{
20public:
22
23 GravityVectorInterface(const MooseObject * moose_object);
24
26 Real gravityMagnitude() const { return _gravity_magnitude; }
28 const RealVectorValue & gravityVector() const { return _gravity_vector; }
30 const RealVectorValue & gravityDirection() const { return _gravity_direction; }
31
32private:
34 RealVectorValue _gravity_vector;
38 RealVectorValue _gravity_direction;
39};
Interface for specifying gravity vector.
Real gravityMagnitude() const
Gets gravity magnitude.
const RealVectorValue & gravityDirection() const
Gets gravity direction (zero vector if zero magnitude)
RealVectorValue _gravity_direction
Gravitational acceleration unit direction.
RealVectorValue _gravity_vector
Gravitational acceleration vector.
Real _gravity_magnitude
Gravitational acceleration magnitude.
static InputParameters validParams()
const RealVectorValue & gravityVector() const
Gets gravity magnitude.