GetTemperatureVector Struct Reference

#include <GetTemperature.H>

Public Member Functions
	GetTemperatureVector (TemperatureProperties const &temp) noexcept
	Construct the functor with information provided by temp.
AMREX_GPU_HOST_DEVICE amrex::XDim3	operator() (amrex::Real const x, amrex::Real const y, amrex::Real const z) const noexcept
	Functor call. Returns the value of temperature at the location (x,y,z).

Public Attributes
TemperatureInitType	m_type
amrex::Real	m_ux_std {0}
amrex::Real	m_uy_std {0}
amrex::Real	m_uz_std {0}
amrex::ParserExecutor< 3 >	m_ux_std_parser
amrex::ParserExecutor< 3 >	m_uy_std_parser
amrex::ParserExecutor< 3 >	m_uz_std_parser

Constructor & Destructor Documentation

GetTemperatureVector()

GetTemperatureVector::GetTemperatureVector ( TemperatureProperties const & temp )

explicitnoexcept

Construct the functor with information provided by temp.

Parameters

[in]

temp

const reference to the TemperatureProperties object that will be used to populate the functor

Member Function Documentation

operator()()

AMREX_GPU_HOST_DEVICE amrex::XDim3 GetTemperatureVector::operator() ( amrex::Real const x, amrex::Real const y, amrex::Real const z ) const

inlinenoexcept

Functor call. Returns the value of temperature at the location (x,y,z).

Parameters

[in]	x	x-coordinate of given location
[in]	y	y-coordinate of given location
[in]	z	z-cooridnate of given location

Returns

value of temperature at (x,y,z). m_ux_std, m_uy_std, m_uz_std if m_type is TempConstantVector m_ux_std_parser(x,y,z), m_uy_std_parser(x,y,z), m_uz_std_parser(x,y,z) if m_type is TempParserFunctionVector

Member Data Documentation

m_type

TemperatureInitType GetTemperatureVector::m_type

m_ux_std

amrex::Real GetTemperatureVector::m_ux_std {0}

m_ux_std_parser

amrex::ParserExecutor<3> GetTemperatureVector::m_ux_std_parser

m_uy_std

amrex::Real GetTemperatureVector::m_uy_std {0}

m_uy_std_parser

amrex::ParserExecutor<3> GetTemperatureVector::m_uy_std_parser

m_uz_std

amrex::Real GetTemperatureVector::m_uz_std {0}

m_uz_std_parser

amrex::ParserExecutor<3> GetTemperatureVector::m_uz_std_parser

---

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

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