VelocityProperties Struct Reference

Struct to store velocity properties, for use in momentum initialization. More...

#include <VelocityProperties.H>

Public Member Functions
	VelocityProperties (const amrex::ParmParse &pp)
	Read runtime parameters to populate constant or spatially-varying velocity information. More...

Public Attributes
VelocityInitType	m_type
int	m_dir
int	m_sign_dir
amrex::Real	m_velocity
std::unique_ptr< amrex::Parser >	m_ptr_velocity_parser

Detailed Description

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.

Constructor & Destructor Documentation

VelocityProperties()

VelocityProperties::VelocityProperties

(

const amrex::ParmParse &

pp

)

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

Member Data Documentation

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

VelocityInitType VelocityProperties::m_type

m_velocity

amrex::Real VelocityProperties::m_velocity

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/23.11/Source/Initialization/VelocityProperties.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/23.11/Source/Initialization/VelocityProperties.cpp