Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
Classes | Public Types | Public Attributes | Static Public Attributes | List of all members
shammodels::ExtForceVariant< Tvec > Struct Template Reference

Classes

struct  LenseThirring
 
struct  PointMass
 
struct  ShearingBoxForce
 Shearing box forces as in athena [3]. More...
 
struct  VelocityDissipation
 f = -eta v More...
 
struct  VerticalDiscPotential
 f = -GMy / sqrt(R0^2 + y^2) More...
 

Public Types

using Tscal = shambase::VecComponent< Tvec >
 
using VariantForce = std::variant< PointMass, LenseThirring, ShearingBoxForce, VerticalDiscPotential, VelocityDissipation >
 

Public Attributes

VariantForce val
 

Static Public Attributes

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

Detailed Description

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

Definition at line 32 of file ExtForceConfig.hpp.

Member Typedef Documentation

◆ Tscal

template<class Tvec >
using shammodels::ExtForceVariant< Tvec >::Tscal = shambase::VecComponent<Tvec>

Definition at line 33 of file ExtForceConfig.hpp.

◆ VariantForce

template<class Tvec >
using shammodels::ExtForceVariant< Tvec >::VariantForce = std::variant< PointMass, LenseThirring, ShearingBoxForce, VerticalDiscPotential, VelocityDissipation>

Definition at line 82 of file ExtForceConfig.hpp.

Member Data Documentation

◆ dim

template<class Tvec >
constexpr u32 shammodels::ExtForceVariant< Tvec >::dim = shambase::VectorProperties<Tvec>::dimension
staticconstexpr

Definition at line 34 of file ExtForceConfig.hpp.

◆ val

template<class Tvec >
VariantForce shammodels::ExtForceVariant< Tvec >::val

Definition at line 88 of file ExtForceConfig.hpp.


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