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

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]tempconst 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]xx-coordinate of given location
[in]yy-coordinate of given location
[in]zz-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: