GetTemperature Struct Reference

Get temperature at a point on the grid. More...

#include <GetTemperature.H>

Public Member Functions
	GetTemperature (TemperatureProperties const &temp) noexcept
	Construct the functor with information provided by temp.
AMREX_GPU_HOST_DEVICE amrex::Real	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_temperature
amrex::ParserExecutor< 3 >	m_temperature_parser

Detailed Description

Get temperature at a point on the grid.

Functor to return temperature at a point on the grid, either constant (m_temperature) or a spatially varying value computed using the parser function (m_temperature_parser). It provides the temperature information held by the TemperatureProperties instance passed to the constructor.

Constructor & Destructor Documentation

GetTemperature()

GetTemperature::GetTemperature ( 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::Real GetTemperature::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_temperature if m_type is TempConstantValue m_temperature_parser(x,y,z) if m_type is TempParserFunction

Member Data Documentation

m_temperature

amrex::Real GetTemperature::m_temperature

m_temperature_parser

amrex::ParserExecutor<3> GetTemperature::m_temperature_parser

m_type

TemperatureInitType GetTemperature::m_type

---

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

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