WarpX
Public Member Functions | Public Attributes | List of all members
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. More...
 

Public Attributes

TemperatureInitType m_type
 
amrex::Real m_temperature
 
std::unique_ptr< amrex::Parserm_ptr_temperature_parser
 

Detailed Description

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

Reads in and stores temperature 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 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]ppReference to the parameter parser object for the species being initialized
[in]source_nameOptional group name of the input parameters

Member Data Documentation

◆ m_ptr_temperature_parser

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

◆ m_temperature

amrex::Real TemperatureProperties::m_temperature

◆ m_type

TemperatureInitType TemperatureProperties::m_type

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