Canoe
Comprehensive Atmosphere N' Ocean Engine
Radiation Class Reference

#include <radiation.hpp>

Inheritance diagram for Radiation:
[legend]

Public Member Functions

 Radiation (MeshBlock *pmb, ParameterInput *pin)
 
 ~Radiation ()
 
size_t GetNumBands () const
 Get number of bands. More...
 
std::shared_ptr< RadiationBandGetBand (int i) const
 Get band by index. More...
 
std::shared_ptr< RadiationBandGetBandByName (std::string const &name) const
 Get band by name. More...
 
Direction const & GetRayInput (int i) const
 Get incoming ray by index. More...
 
size_t GetNumOutgoingRays () const
 Get total number of incoming rays. More...
 
void CalRadiativeFlux (MeshBlock const *pmb, int k, int j, int il, int iu)
 Calculate the radiative flux. More...
 
void CalRadiance (MeshBlock const *pmb, int k, int j)
 Calculate the radiance. More...
 
void AddRadiativeFlux (Hydro *phydro, int k, int j, int il, int iu) const
 Add the radiative flux to hydro energy flux. More...
 
size_t RestartDataSizeInBytes (Mesh const *pm) const override
 
void DumpRestartData (char *pdst) const override
 
size_t LoadRestartData (char *psrt) override
 
- Public Member Functions inherited from RestartGroup
virtual ~RestartGroup ()
 
- Public Member Functions inherited from CounterGroup
virtual ~CounterGroup ()
 
void ResetCounter ()
 
void DecrementCounter (Real dt)
 
Real GetCounter () const
 
void SetCooldownTime (Real cooldown)
 
- Public Member Functions inherited from FlagGroup
 FlagGroup (uint64_t flags=0LL)
 
virtual ~FlagGroup ()
 
int TestFlag (uint64_t flag) const
 
void SetFlag (uint64_t flag)
 

Public Attributes

AthenaArray< Real > radiance
 radiance of all bands More...
 
AthenaArray< Real > flxup
 upward flux of all bands More...
 
AthenaArray< Real > flxdn
 downward flux of all bands More...
 

Static Public Attributes

static const std::string input_key = "radiation_config"
 radiation input key in the input file [radiation_config] More...
 

Protected Attributes

std::vector< RadiationBandPtrbands_
 all radiation bands More...
 
std::vector< DirectionrayInput_
 incomming rays More...
 

Detailed Description

Definition at line 20 of file radiation.hpp.

Constructor & Destructor Documentation

◆ Radiation()

Radiation::Radiation ( MeshBlock *  pmb,
ParameterInput *  pin 
)

Definition at line 37 of file radiation.cpp.

◆ ~Radiation()

Radiation::~Radiation ( )

Definition at line 102 of file radiation.cpp.

Member Function Documentation

◆ GetNumBands()

size_t Radiation::GetNumBands ( ) const
inline

Get number of bands.

Definition at line 44 of file radiation.hpp.

◆ GetBand()

std::shared_ptr<RadiationBand> Radiation::GetBand ( int  i) const
inline

Get band by index.

Definition at line 47 of file radiation.hpp.

◆ GetBandByName()

RadiationBandPtr Radiation::GetBandByName ( std::string const &  name) const

Get band by name.

Definition at line 107 of file radiation.cpp.

◆ GetRayInput()

Direction const& Radiation::GetRayInput ( int  i) const
inline

Get incoming ray by index.

Definition at line 53 of file radiation.hpp.

◆ GetNumOutgoingRays()

size_t Radiation::GetNumOutgoingRays ( ) const

Get total number of incoming rays.

Definition at line 116 of file radiation.cpp.

◆ CalRadiativeFlux()

void Radiation::CalRadiativeFlux ( MeshBlock const *  pmb,
int  k,
int  j,
int  il,
int  iu 
)

Calculate the radiative flux.

Definition at line 124 of file radiation.cpp.

◆ CalRadiance()

void Radiation::CalRadiance ( MeshBlock const *  pmb,
int  k,
int  j 
)

Calculate the radiance.

Definition at line 139 of file radiation.cpp.

◆ AddRadiativeFlux()

void Radiation::AddRadiativeFlux ( Hydro *  phydro,
int  k,
int  j,
int  il,
int  iu 
) const

Add the radiative flux to hydro energy flux.

Definition at line 156 of file radiation.cpp.

◆ RestartDataSizeInBytes()

size_t Radiation::RestartDataSizeInBytes ( Mesh const *  pm) const
overridevirtual

Implements RestartGroup.

Definition at line 167 of file radiation.cpp.

◆ DumpRestartData()

void Radiation::DumpRestartData ( char *  pdst) const
overridevirtual

Implements RestartGroup.

Definition at line 171 of file radiation.cpp.

◆ LoadRestartData()

size_t Radiation::LoadRestartData ( char *  psrc)
overridevirtual
Todo:
check me

Implements RestartGroup.

Definition at line 181 of file radiation.cpp.

Member Data Documentation

◆ input_key

const std::string Radiation::input_key = "radiation_config"
static

radiation input key in the input file [radiation_config]

Definition at line 26 of file radiation.hpp.

◆ radiance

AthenaArray<Real> Radiation::radiance

radiance of all bands

Definition at line 29 of file radiation.hpp.

◆ flxup

AthenaArray<Real> Radiation::flxup

upward flux of all bands

Definition at line 32 of file radiation.hpp.

◆ flxdn

AthenaArray<Real> Radiation::flxdn

downward flux of all bands

Definition at line 35 of file radiation.hpp.

◆ bands_

std::vector<RadiationBandPtr> Radiation::bands_
protected

all radiation bands

Definition at line 76 of file radiation.hpp.

◆ rayInput_

std::vector<Direction> Radiation::rayInput_
protected

incomming rays

Definition at line 79 of file radiation.hpp.


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