shammodels::ExtForceVariant< Tvec >::ShearingBoxForce Struct Reference

Shearing box forces as in athena [3]. More...

#include <shammodels/common/include/shammodels/common/ExtForceConfig.hpp>

Public Member Functions
Tscal	shear_speed (Tscal box_length)
	ShearingBoxForce (Tscal Omega_0, Tscal eta, Tscal q)
	ShearingBoxForce (i32_3 shear_base, i32_3 shear_dir, Tscal Omega_0, Tscal eta, Tscal q)

Public Attributes
i32_3	shear_base = {1, 0, 0}
i32_3	shear_dir = {0, 1, 0}
Tscal	Omega_0
Tscal	eta
Tscal	q

Detailed Description

template<class Tvec>
struct shammodels::ExtForceVariant< Tvec >::ShearingBoxForce

Shearing box forces as in athena [3].

\[ \mathbf{f} = 2\Omega_0 \left( q \Omega_0 x + v_y \right) \basevec{x} -2\Omega_0 v_x \basevec{y} - \Omega_0^2 z \basevec{z} \]

Shear speed :

\[ \omega = q \Omega_0 L_x \]

Definition at line 54 of file ExtForceConfig.hpp.

Constructor & Destructor Documentation

ShearingBoxForce() [1/2]

template<class Tvec >

shammodels::ExtForceVariant< Tvec >::ShearingBoxForce::ShearingBoxForce ( Tscal  Omega_0, Tscal  eta, Tscal  q  )

inline

Definition at line 65 of file ExtForceConfig.hpp.

ShearingBoxForce() [2/2]

template<class Tvec >

shammodels::ExtForceVariant< Tvec >::ShearingBoxForce::ShearingBoxForce ( i32_3  shear_base, i32_3  shear_dir, Tscal  Omega_0, Tscal  eta, Tscal  q  )

inline

Definition at line 67 of file ExtForceConfig.hpp.

Member Function Documentation

shear_speed()

template<class Tvec >

Tscal shammodels::ExtForceVariant< Tvec >::ShearingBoxForce::shear_speed ( Tscal  box_length )

inline

Definition at line 62 of file ExtForceConfig.hpp.

Member Data Documentation

eta

template<class Tvec >

Tscal shammodels::ExtForceVariant< Tvec >::ShearingBoxForce::eta

Definition at line 59 of file ExtForceConfig.hpp.

Omega_0

template<class Tvec >

Tscal shammodels::ExtForceVariant< Tvec >::ShearingBoxForce::Omega_0

Definition at line 58 of file ExtForceConfig.hpp.

q

template<class Tvec >

Tscal shammodels::ExtForceVariant< Tvec >::ShearingBoxForce::q

Definition at line 60 of file ExtForceConfig.hpp.

shear_base

template<class Tvec >

i32_3 shammodels::ExtForceVariant< Tvec >::ShearingBoxForce::shear_base = {1, 0, 0}

Definition at line 55 of file ExtForceConfig.hpp.

shear_dir

template<class Tvec >

i32_3 shammodels::ExtForceVariant< Tvec >::ShearingBoxForce::shear_dir = {0, 1, 0}

Definition at line 56 of file ExtForceConfig.hpp.

---

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

• shammodels/common/include/shammodels/common/ExtForceConfig.hpp