Athena++/Atmosphere
Planetary Atmosphere Simulator
HydroSourceTerms Class Reference

#include <hydro_srcterms.hpp>

Public Member Functions

 HydroSourceTerms (Hydro *phyd, ParameterInput *pin)
 
Real GetGM () const
 
Real GetG1 () const
 
Real GetG2 () const
 
Real GetG3 () const
 
Real GetOmegaX () const
 
Real GetOmegaY () const
 
Real GetOmegaZ () const
 
void AddHydroSourceTerms (const Real time, const Real dt, const AthenaArray< Real > *flx, const AthenaArray< Real > &p, const AthenaArray< Real > &b, AthenaArray< Real > &c)
 
void PointMass (const Real dt, const AthenaArray< Real > *flx, const AthenaArray< Real > &p, AthenaArray< Real > &c)
 
void ConstantAcceleration (const Real dt, const AthenaArray< Real > *flx, const AthenaArray< Real > &p, AthenaArray< Real > &c)
 
void ShearingBoxSourceTerms (const Real dt, const AthenaArray< Real > *flx, const AthenaArray< Real > &p, AthenaArray< Real > &c)
 
Real UnstratifiedDisk (const Real x1, const Real x2, const Real x3)
 
void SelfGravity (const Real dt, const AthenaArray< Real > *flx, const AthenaArray< Real > &p, AthenaArray< Real > &c)
 
void EnrollSrcTermFunction (SrcTermFunc my_func)
 
void Coriolis123 (const Real dt, const AthenaArray< Real > *flx, const AthenaArray< Real > &p, AthenaArray< Real > &c)
 source terms due to constant coriolis acceleration More...
 
void CoriolisXYZ (const Real dt, const AthenaArray< Real > *flx, const AthenaArray< Real > &p, AthenaArray< Real > &c)
 add source terms for constant coriolis acceleration in More...
 

Public Attributes

bool hydro_sourceterms_defined
 
SrcTermFunc UserSourceTerm
 

Private Attributes

Hydropmy_hydro_
 
Real gm_
 
Real g1_
 
Real g2_
 
Real g3_
 
Real Omega_0_
 
Real qshear_
 
int ShBoxCoord_
 
Real omega1_
 
Real omega2_
 
Real omega3_
 
Real omegax_
 
Real omegay_
 
Real omegaz_
 

Detailed Description

Definition at line 27 of file hydro_srcterms.hpp.

Constructor & Destructor Documentation

◆ HydroSourceTerms()

HydroSourceTerms::HydroSourceTerms ( Hydro phyd,
ParameterInput pin 
)

Definition at line 28 of file hydro_srcterms.cpp.

Member Function Documentation

◆ GetGM()

Real HydroSourceTerms::GetGM ( ) const
inline

Definition at line 32 of file hydro_srcterms.hpp.

◆ GetG1()

Real HydroSourceTerms::GetG1 ( ) const
inline

Definition at line 33 of file hydro_srcterms.hpp.

◆ GetG2()

Real HydroSourceTerms::GetG2 ( ) const
inline

Definition at line 34 of file hydro_srcterms.hpp.

◆ GetG3()

Real HydroSourceTerms::GetG3 ( ) const
inline

Definition at line 35 of file hydro_srcterms.hpp.

◆ GetOmegaX()

Real HydroSourceTerms::GetOmegaX ( ) const
inline

Definition at line 36 of file hydro_srcterms.hpp.

◆ GetOmegaY()

Real HydroSourceTerms::GetOmegaY ( ) const
inline

Definition at line 37 of file hydro_srcterms.hpp.

◆ GetOmegaZ()

Real HydroSourceTerms::GetOmegaZ ( ) const
inline

Definition at line 38 of file hydro_srcterms.hpp.

◆ AddHydroSourceTerms()

void HydroSourceTerms::AddHydroSourceTerms ( const Real  time,
const Real  dt,
const AthenaArray< Real > *  flx,
const AthenaArray< Real > &  p,
const AthenaArray< Real > &  b,
AthenaArray< Real > &  c 
)

Definition at line 95 of file hydro_srcterms.cpp.

◆ PointMass()

void HydroSourceTerms::PointMass ( const Real  dt,
const AthenaArray< Real > *  flx,
const AthenaArray< Real > &  p,
AthenaArray< Real > &  c 
)

◆ ConstantAcceleration()

void HydroSourceTerms::ConstantAcceleration ( const Real  dt,
const AthenaArray< Real > *  flx,
const AthenaArray< Real > &  p,
AthenaArray< Real > &  c 
)

Definition at line 24 of file constant_acc.cpp.

◆ ShearingBoxSourceTerms()

void HydroSourceTerms::ShearingBoxSourceTerms ( const Real  dt,
const AthenaArray< Real > *  flx,
const AthenaArray< Real > &  p,
AthenaArray< Real > &  c 
)

◆ UnstratifiedDisk()

Real HydroSourceTerms::UnstratifiedDisk ( const Real  x1,
const Real  x2,
const Real  x3 
)

◆ SelfGravity()

void HydroSourceTerms::SelfGravity ( const Real  dt,
const AthenaArray< Real > *  flx,
const AthenaArray< Real > &  p,
AthenaArray< Real > &  c 
)

◆ EnrollSrcTermFunction()

void HydroSourceTerms::EnrollSrcTermFunction ( SrcTermFunc  my_func)

◆ Coriolis123()

void HydroSourceTerms::Coriolis123 ( const Real  dt,
const AthenaArray< Real > *  flx,
const AthenaArray< Real > &  prim,
AthenaArray< Real > &  cons 
)

source terms due to constant coriolis acceleration

add source terms for constant coriolis acceleration in

Definition at line 18 of file coriolis_acc.cpp.

◆ CoriolisXYZ()

void HydroSourceTerms::CoriolisXYZ ( const Real  dt,
const AthenaArray< Real > *  flx,
const AthenaArray< Real > &  p,
AthenaArray< Real > &  c 
)

add source terms for constant coriolis acceleration in

Definition at line 44 of file coriolis_acc.cpp.

Member Data Documentation

◆ hydro_sourceterms_defined

bool HydroSourceTerms::hydro_sourceterms_defined

Definition at line 41 of file hydro_srcterms.hpp.

◆ UserSourceTerm

SrcTermFunc HydroSourceTerms::UserSourceTerm

Definition at line 59 of file hydro_srcterms.hpp.

◆ pmy_hydro_

Hydro* HydroSourceTerms::pmy_hydro_
private

Definition at line 68 of file hydro_srcterms.hpp.

◆ gm_

Real HydroSourceTerms::gm_
private

Definition at line 69 of file hydro_srcterms.hpp.

◆ g1_

Real HydroSourceTerms::g1_
private

Definition at line 70 of file hydro_srcterms.hpp.

◆ g2_

Real HydroSourceTerms::g2_
private

Definition at line 70 of file hydro_srcterms.hpp.

◆ g3_

Real HydroSourceTerms::g3_
private

Definition at line 70 of file hydro_srcterms.hpp.

◆ Omega_0_

Real HydroSourceTerms::Omega_0_
private

Definition at line 71 of file hydro_srcterms.hpp.

◆ qshear_

Real HydroSourceTerms::qshear_
private

Definition at line 71 of file hydro_srcterms.hpp.

◆ ShBoxCoord_

int HydroSourceTerms::ShBoxCoord_
private

Definition at line 72 of file hydro_srcterms.hpp.

◆ omega1_

Real HydroSourceTerms::omega1_
private

Definition at line 74 of file hydro_srcterms.hpp.

◆ omega2_

Real HydroSourceTerms::omega2_
private

Definition at line 74 of file hydro_srcterms.hpp.

◆ omega3_

Real HydroSourceTerms::omega3_
private

Definition at line 74 of file hydro_srcterms.hpp.

◆ omegax_

Real HydroSourceTerms::omegax_
private

Definition at line 75 of file hydro_srcterms.hpp.

◆ omegay_

Real HydroSourceTerms::omegay_
private

Definition at line 75 of file hydro_srcterms.hpp.

◆ omegaz_

Real HydroSourceTerms::omegaz_
private

Definition at line 75 of file hydro_srcterms.hpp.


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