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, std::string const &source_name)
	Read runtime parameters to populate constant or spatially-varying velocity information.

Public Attributes
VelocityInitType	m_type
amrex::Real	m_ux_mean {0.0}
amrex::Real	m_uy_mean {0.0}
amrex::Real	m_uz_mean {0.0}
std::unique_ptr< amrex::Parser >	m_ptr_ux_mean_parser
std::unique_ptr< amrex::Parser >	m_ptr_uy_mean_parser
std::unique_ptr< amrex::Parser >	m_ptr_uz_mean_parser

Detailed Description

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

Reads in and stores velocity used to initialize the Maxwellian and Maxwell-Juttner momentum distributions in InjectorMomentum. The information is read from the parameters of the species being initialized, and will be accessed by GetVelocityVector.

Constructor & Destructor Documentation

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

Construct VelocityProperties from the passed particle source parameters. Parse the momentum distribution type and initialize the corresponding velocity parameters: ux_mean, uy_mean, and uz_mean (or the parser functions ux_mean_function, uy_mean_function, uz_mean_function) for the maxwellian and maxwell_juttner distributions; or the parser functions momentum_function_ux, momentum_function_uy, momentum_function_uz for parse_momentum_function.

Member Data Documentation

m_ptr_ux_mean_parser

std::unique_ptr<amrex::Parser> VelocityProperties::m_ptr_ux_mean_parser

m_ptr_uy_mean_parser

std::unique_ptr<amrex::Parser> VelocityProperties::m_ptr_uy_mean_parser

m_ptr_uz_mean_parser

std::unique_ptr<amrex::Parser> VelocityProperties::m_ptr_uz_mean_parser

m_type

VelocityInitType VelocityProperties::m_type

m_ux_mean

amrex::Real VelocityProperties::m_ux_mean {0.0}

m_uy_mean

amrex::Real VelocityProperties::m_uy_mean {0.0}

m_uz_mean

amrex::Real VelocityProperties::m_uz_mean {0.0}

---

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

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