TemperatureProperties Struct Reference

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

#include <TemperatureProperties.H>

Public Member Functions
	TemperatureProperties (const amrex::ParmParse &pp, std::string const &source_name)
	Read runtime parameters to populate constant or spatially-varying temperature information.

Public Attributes
TemperatureInitType	m_type
amrex::Real	m_temperature
std::unique_ptr< amrex::Parser >	m_ptr_temperature_parser
amrex::Real	m_ux_std {0.0}
amrex::Real	m_uy_std {0.0}
amrex::Real	m_uz_std {0.0}
std::unique_ptr< amrex::Parser >	m_ptr_ux_std_parser
std::unique_ptr< amrex::Parser >	m_ptr_uy_std_parser
std::unique_ptr< amrex::Parser >	m_ptr_uz_std_parser

Detailed Description

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

Reads in and stores temperature 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 GetTemperature.

Constructor & Destructor Documentation

TemperatureProperties()

TemperatureProperties::TemperatureProperties	(	const amrex::ParmParse &	pp,
		std::string const &	source_name )

Read runtime parameters to populate constant or spatially-varying temperature information.

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 TemperatureProperties from the passed particle source parameters. Parse the momentum distribution type and initialize the corresponding temperature parameters: thermal spread ux_std, uy_std, uz_std for maxwellian distribution, and theta for maxwell_juttner.

Member Data Documentation

m_ptr_temperature_parser

std::unique_ptr<amrex::Parser> TemperatureProperties::m_ptr_temperature_parser

m_ptr_ux_std_parser

std::unique_ptr<amrex::Parser> TemperatureProperties::m_ptr_ux_std_parser

m_ptr_uy_std_parser

std::unique_ptr<amrex::Parser> TemperatureProperties::m_ptr_uy_std_parser

m_ptr_uz_std_parser

std::unique_ptr<amrex::Parser> TemperatureProperties::m_ptr_uz_std_parser

m_temperature

amrex::Real TemperatureProperties::m_temperature

m_type

TemperatureInitType TemperatureProperties::m_type

m_ux_std

amrex::Real TemperatureProperties::m_ux_std {0.0}

m_uy_std

amrex::Real TemperatureProperties::m_uy_std {0.0}

m_uz_std

amrex::Real TemperatureProperties::m_uz_std {0.0}

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.06/Source/Initialization/TemperatureProperties.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.06/Source/Initialization/TemperatureProperties.cpp