Line data    Source code

       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             : 
      15             : /**
      16             :  * Interface for specifying gravity vector
      17             :  */
      18             : class GravityVectorInterface
      19             : {
      20             : public:
      21             :   static InputParameters validParams();
      22             : 
      23             :   GravityVectorInterface(const MooseObject * moose_object);
      24             : 
      25             :   /// Gets gravity magnitude
      26          21 :   Real gravityMagnitude() const { return _gravity_magnitude; }
      27             :   /// Gets gravity magnitude
      28             :   const RealVectorValue & gravityVector() const { return _gravity_vector; }
      29             :   /// Gets gravity direction (zero vector if zero magnitude)
      30             :   const RealVectorValue & gravityDirection() const { return _gravity_direction; }
      31             : 
      32             : private:
      33             :   /// Gravitational acceleration vector
      34             :   RealVectorValue _gravity_vector;
      35             :   /// Gravitational acceleration magnitude
      36             :   Real _gravity_magnitude;
      37             :   /// Gravitational acceleration unit direction
      38             :   RealVectorValue _gravity_direction;
      39             : };