Canoe
Comprehensive Atmosphere N' Ocean Engine
Physics Class Reference

manages all physics package data and functions More...

#include <physics.hpp>

Public Member Functions

 Physics (MeshBlock *pmb, ParameterInput *pin)
 
 ~Physics ()
 
void Initialize (AthenaArray< Real > const &w)
 
size_t RestartDataSizeInBytes ()
 
size_t DumpRestartData (char *pdst)
 
size_t LoadRestartData (char *psrc)
 
void ApplyPhysicsPackages (AthenaArray< Real > &du, AthenaArray< Real > const &w, Real time, Real dt)
 
TaskStatus RelaxBotTemperature (AthenaArray< Real > &du, AthenaArray< Real > const &w, Real time, Real dt)
 
TaskStatus RelaxBotVelocity (AthenaArray< Real > &du, AthenaArray< Real > const &w, Real time, Real dt)
 
TaskStatus RelaxBotComposition (AthenaArray< Real > &du, AthenaArray< Real > const &w, Real time, Real dt)
 
TaskStatus TopSpongeLayer (AthenaArray< Real > &du, AthenaArray< Real > const &w, Real time, Real dt)
 
TaskStatus BotSpongeLayer (AthenaArray< Real > &du, AthenaArray< Real > const &w, Real time, Real dt)
 
TaskStatus LeftSpongeLayer (AthenaArray< Real > &du, AthenaArray< Real > const &w, Real time, Real dt)
 
TaskStatus RightSpongeLayer (AthenaArray< Real > &du, AthenaArray< Real > const &w, Real time, Real dt)
 
TaskStatus TopCooling (AthenaArray< Real > &du, AthenaArray< Real > const &w, Real time, Real dt)
 
TaskStatus BotHeating (AthenaArray< Real > &du, AthenaArray< Real > const &w, Real time, Real dt)
 

Public Attributes

MeshBlock * pmy_block
 
TaskManager< Physics > * ptm
 

Protected Attributes

std::vector< PhysicsPackagepackages_
 
AthenaArray< Real > hydro_bot_
 
AthenaArray< Real > tem_bot_
 
AthenaArray< Real > vel_bot_
 
AthenaArray< Real > com_bot_
 
Real Tbot_
 
Real tau_Tbot_
 
Real tau_Ubot_
 
Real tau_Qbot_
 
Real tau_top_
 
Real width_top_
 
Real tau_bot_
 
Real width_bot_
 
Real tau_left_
 
Real width_left_
 
Real tau_right_
 
Real width_right_
 
Real dTdt_
 
Real flux_top_
 
Real flux_bot_
 
Real friction_bot_tau_
 

Detailed Description

manages all physics package data and functions

Definition at line 21 of file physics.hpp.

Constructor & Destructor Documentation

◆ Physics()

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

Definition at line 12 of file register_package.cpp.

◆ ~Physics()

Physics::~Physics ( )

Definition at line 10 of file physics.cpp.

Member Function Documentation

◆ Initialize()

void Physics::Initialize ( AthenaArray< Real > const &  w)

Definition at line 135 of file register_package.cpp.

◆ RestartDataSizeInBytes()

size_t Physics::RestartDataSizeInBytes ( )

Definition at line 33 of file physics.cpp.

◆ DumpRestartData()

size_t Physics::DumpRestartData ( char *  pdst)

Definition at line 40 of file physics.cpp.

◆ LoadRestartData()

size_t Physics::LoadRestartData ( char *  psrc)

Definition at line 45 of file physics.cpp.

◆ ApplyPhysicsPackages()

void Physics::ApplyPhysicsPackages ( AthenaArray< Real > &  du,
AthenaArray< Real > const &  w,
Real  time,
Real  dt 
)
Todo:
THIS HAS BEEN CHANGED u -> du. CHECK other packages for updates

Definition at line 13 of file physics.cpp.

◆ RelaxBotTemperature()

TaskStatus Physics::RelaxBotTemperature ( AthenaArray< Real > &  du,
AthenaArray< Real > const &  w,
Real  time,
Real  dt 
)

Definition at line 10 of file relax_bot_temperature.cpp.

◆ RelaxBotVelocity()

TaskStatus Physics::RelaxBotVelocity ( AthenaArray< Real > &  du,
AthenaArray< Real > const &  w,
Real  time,
Real  dt 
)

◆ RelaxBotComposition()

TaskStatus Physics::RelaxBotComposition ( AthenaArray< Real > &  du,
AthenaArray< Real > const &  w,
Real  time,
Real  dt 
)

◆ TopSpongeLayer()

TaskStatus Physics::TopSpongeLayer ( AthenaArray< Real > &  du,
AthenaArray< Real > const &  w,
Real  time,
Real  dt 
)

Definition at line 10 of file sponge_layer.cpp.

◆ BotSpongeLayer()

TaskStatus Physics::BotSpongeLayer ( AthenaArray< Real > &  du,
AthenaArray< Real > const &  w,
Real  time,
Real  dt 
)

Definition at line 44 of file sponge_layer.cpp.

◆ LeftSpongeLayer()

TaskStatus Physics::LeftSpongeLayer ( AthenaArray< Real > &  du,
AthenaArray< Real > const &  w,
Real  time,
Real  dt 
)

Definition at line 78 of file sponge_layer.cpp.

◆ RightSpongeLayer()

TaskStatus Physics::RightSpongeLayer ( AthenaArray< Real > &  du,
AthenaArray< Real > const &  w,
Real  time,
Real  dt 
)

Definition at line 112 of file sponge_layer.cpp.

◆ TopCooling()

TaskStatus Physics::TopCooling ( AthenaArray< Real > &  du,
AthenaArray< Real > const &  w,
Real  time,
Real  dt 
)

Definition at line 10 of file heating_cooling.cpp.

◆ BotHeating()

TaskStatus Physics::BotHeating ( AthenaArray< Real > &  du,
AthenaArray< Real > const &  w,
Real  time,
Real  dt 
)

Definition at line 41 of file heating_cooling.cpp.

Member Data Documentation

◆ pmy_block

MeshBlock* Physics::pmy_block

Definition at line 24 of file physics.hpp.

◆ ptm

TaskManager<Physics>* Physics::ptm

Definition at line 25 of file physics.hpp.

◆ packages_

std::vector<PhysicsPackage> Physics::packages_
protected

Definition at line 64 of file physics.hpp.

◆ hydro_bot_

AthenaArray<Real> Physics::hydro_bot_
protected

Definition at line 67 of file physics.hpp.

◆ tem_bot_

AthenaArray<Real> Physics::tem_bot_
protected

Definition at line 68 of file physics.hpp.

◆ vel_bot_

AthenaArray<Real> Physics::vel_bot_
protected

Definition at line 68 of file physics.hpp.

◆ com_bot_

AthenaArray<Real> Physics::com_bot_
protected

Definition at line 68 of file physics.hpp.

◆ Tbot_

Real Physics::Tbot_
protected

Definition at line 71 of file physics.hpp.

◆ tau_Tbot_

Real Physics::tau_Tbot_
protected

Definition at line 71 of file physics.hpp.

◆ tau_Ubot_

Real Physics::tau_Ubot_
protected

Definition at line 71 of file physics.hpp.

◆ tau_Qbot_

Real Physics::tau_Qbot_
protected

Definition at line 71 of file physics.hpp.

◆ tau_top_

Real Physics::tau_top_
protected

top sponge layer time scale [s]

Definition at line 74 of file physics.hpp.

◆ width_top_

Real Physics::width_top_
protected

top sponge layer width [m]

Definition at line 75 of file physics.hpp.

◆ tau_bot_

Real Physics::tau_bot_
protected

bottom sponge layer time scale [s]

Definition at line 77 of file physics.hpp.

◆ width_bot_

Real Physics::width_bot_
protected

bottom sponge layer width [m]

Definition at line 78 of file physics.hpp.

◆ tau_left_

Real Physics::tau_left_
protected

left sponge layer time scale [s]

Definition at line 80 of file physics.hpp.

◆ width_left_

Real Physics::width_left_
protected

left sponge layer width [m]

Definition at line 81 of file physics.hpp.

◆ tau_right_

Real Physics::tau_right_
protected

right sponge layer time scale [s]

Definition at line 83 of file physics.hpp.

◆ width_right_

Real Physics::width_right_
protected

right sponge layer width [m]

Definition at line 84 of file physics.hpp.

◆ dTdt_

Real Physics::dTdt_
protected

heating rate [K/s]

Definition at line 87 of file physics.hpp.

◆ flux_top_

Real Physics::flux_top_
protected

top heating flux [W/m^2]

Definition at line 88 of file physics.hpp.

◆ flux_bot_

Real Physics::flux_bot_
protected

bot heating flux [W/m^2]

Definition at line 89 of file physics.hpp.

◆ friction_bot_tau_

Real Physics::friction_bot_tau_
protected

Definition at line 92 of file physics.hpp.


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