shammodels::ExtForceConfig< Tvec > Struct Template Reference

Collaboration diagram for shammodels::ExtForceConfig< Tvec >:

Public Types
using	Tscal = shambase::VecComponent< Tvec >
using	PointMass = typename ExtForceVariant< Tvec >::PointMass
using	LenseThirring = typename ExtForceVariant< Tvec >::LenseThirring
using	ShearingBoxForce = typename ExtForceVariant< Tvec >::ShearingBoxForce
using	VerticalDiscPotential = typename ExtForceVariant< Tvec >::VerticalDiscPotential
using	VelocityDissipation = typename ExtForceVariant< Tvec >::VelocityDissipation

Public Member Functions
void	add_point_mass (Tscal central_mass, Tscal Racc)
void	add_lense_thirring (Tscal central_mass, Tscal Racc, Tscal a_spin, Tvec dir_spin)
void	add_shearing_box (Tscal Omega_0, Tscal eta, Tscal q)
void	add_vertical_disc_potential (Tscal central_mass, Tscal R0)
void	add_velocity_dissipation (Tscal eta)

Public Attributes
std::vector< ExtForceVariant< Tvec > >	ext_forces

Static Public Attributes
static constexpr u32	dim = shambase::VectorProperties<Tvec>::dimension

Detailed Description

template<class Tvec>
struct shammodels::ExtForceConfig< Tvec >

Definition at line 92 of file ExtForceConfig.hpp.

Member Typedef Documentation

LenseThirring

template<class Tvec >

using shammodels::ExtForceConfig< Tvec >::LenseThirring = typename ExtForceVariant<Tvec>::LenseThirring

Definition at line 98 of file ExtForceConfig.hpp.

PointMass

template<class Tvec >

using shammodels::ExtForceConfig< Tvec >::PointMass = typename ExtForceVariant<Tvec>::PointMass

Definition at line 97 of file ExtForceConfig.hpp.

ShearingBoxForce

template<class Tvec >

using shammodels::ExtForceConfig< Tvec >::ShearingBoxForce = typename ExtForceVariant<Tvec>::ShearingBoxForce

Definition at line 99 of file ExtForceConfig.hpp.

Tscal

template<class Tvec >

using shammodels::ExtForceConfig< Tvec >::Tscal = shambase::VecComponent<Tvec>

Definition at line 94 of file ExtForceConfig.hpp.

VelocityDissipation

template<class Tvec >

using shammodels::ExtForceConfig< Tvec >::VelocityDissipation = typename ExtForceVariant<Tvec>::VelocityDissipation

Definition at line 101 of file ExtForceConfig.hpp.

VerticalDiscPotential

template<class Tvec >

using shammodels::ExtForceConfig< Tvec >::VerticalDiscPotential = typename ExtForceVariant<Tvec>::VerticalDiscPotential

Definition at line 100 of file ExtForceConfig.hpp.

Member Function Documentation

add_lense_thirring()

template<class Tvec >

void shammodels::ExtForceConfig< Tvec >::add_lense_thirring ( Tscal  central_mass, Tscal  Racc, Tscal  a_spin, Tvec  dir_spin  )

inline

Definition at line 109 of file ExtForceConfig.hpp.

add_point_mass()

template<class Tvec >

void shammodels::ExtForceConfig< Tvec >::add_point_mass ( Tscal  central_mass, Tscal  Racc  )

inline

Definition at line 105 of file ExtForceConfig.hpp.

add_shearing_box()

template<class Tvec >

void shammodels::ExtForceConfig< Tvec >::add_shearing_box ( Tscal  Omega_0, Tscal  eta, Tscal  q  )

inline

Todo:

add check for norm of shear vectors

Definition at line 123 of file ExtForceConfig.hpp.

add_velocity_dissipation()

template<class Tvec >

void shammodels::ExtForceConfig< Tvec >::add_velocity_dissipation ( Tscal  eta )

inline

Definition at line 132 of file ExtForceConfig.hpp.

add_vertical_disc_potential()

template<class Tvec >

void shammodels::ExtForceConfig< Tvec >::add_vertical_disc_potential ( Tscal  central_mass, Tscal  R0  )

inline

Definition at line 128 of file ExtForceConfig.hpp.

Member Data Documentation

dim

template<class Tvec >

constexpr u32 shammodels::ExtForceConfig< Tvec >::dim = shambase::VectorProperties<Tvec>::dimension

staticconstexpr

Definition at line 95 of file ExtForceConfig.hpp.

ext_forces

template<class Tvec >

std::vector<ExtForceVariant<Tvec> > shammodels::ExtForceConfig< Tvec >::ext_forces

Definition at line 103 of file ExtForceConfig.hpp.

---

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

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