Struct to store velocity properties, for use in momentum initialization.
More...
#include <VelocityProperties.H>
Struct to store velocity properties, for use in momentum initialization.
Reads in and stores velocity used to initialize the Maxwell-Boltzmann and Maxwell-Juttner momentum distributions in InjectorMomentum. The information is read from the parameters of the species being initialized, and will be accessed by GetVelocity.
◆ VelocityProperties()
VelocityProperties::VelocityProperties |
( |
const amrex::ParmParse & |
pp, |
|
|
std::string const & |
source_name |
|
) |
| |
Read runtime parameters to populate constant or spatially-varying velocity information.
Construct VelocityProperties based on the passed parameters. If velocity is a constant, store value. If a parser, make and store the parser function
- Parameters
-
[in] | pp | Reference to the parameter parser object for the species being initialized |
[in] | source_name | Optional group name of the input parameters |
◆ m_dir
int VelocityProperties::m_dir |
◆ m_ptr_velocity_parser
std::unique_ptr<amrex::Parser> VelocityProperties::m_ptr_velocity_parser |
◆ m_sign_dir
int VelocityProperties::m_sign_dir |
◆ m_type
◆ m_velocity
amrex::Real VelocityProperties::m_velocity {0} |
The documentation for this struct was generated from the following files:
- /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/latest/Source/Initialization/VelocityProperties.H
- /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/latest/Source/Initialization/VelocityProperties.cpp