WarpX
|
#include <GetVelocity.H>
Public Member Functions | |
GetVelocity (VelocityProperties const &vel) noexcept | |
Construct the functor with information provided by vel. More... | |
AMREX_GPU_HOST_DEVICE amrex::Real | operator() (amrex::Real const x, amrex::Real const y, amrex::Real const z) const noexcept |
Functor call. Returns the value of velocity at the location (x,y,z) More... | |
AMREX_GPU_HOST_DEVICE int | direction () const noexcept |
Returns the index of the direction of the bulk velocity. More... | |
Public Attributes | |
VelocityInitType | m_type |
int | m_dir |
int | m_sign_dir |
Index x=0, y=1, z=2. More... | |
amrex::Real | m_velocity {0} |
Sign of the velocity direction positive=1, negative=-1. More... | |
amrex::ParserExecutor< 3 > | m_velocity_parser |
Get velocity at a point on the grid
Class to get velocity at a point on the grid, either constant (m_velocity) or a spatially varying value computed using the parser function (m_velocity_parser). It also stores the direction of the velocity field. It provides the velocity information held by the VelocityProperties instance passed to the constructor.
|
noexcept |
Construct the functor with information provided by vel.
[in] | vel | const reference to the VelocityProperties object that will be used to populate the functor |
|
inlinenoexcept |
Returns the index of the direction of the bulk velocity.
|
inlinenoexcept |
Functor call. Returns the value of velocity at the location (x,y,z)
[in] | x | x-coordinate of given location |
[in] | y | y-coordinate of given location |
[in] | z | z-cooridnate of given location |
int GetVelocity::m_dir |
int GetVelocity::m_sign_dir |
Index x=0, y=1, z=2.
VelocityInitType GetVelocity::m_type |
amrex::Real GetVelocity::m_velocity {0} |
Sign of the velocity direction positive=1, negative=-1.
Constant velocity value, if m_type == VelConstantValue
amrex::ParserExecutor<3> GetVelocity::m_velocity_parser |
Velocity parser function, if m_type == VelParserFunction