Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
shammodels::basegodunov::GravityConfig< Tvec > Struct Template Reference

Public Types

using Tscal = shambase::VecComponent<Tvec>

Public Member Functions

Tscal get_tolerance ()
bool is_gravity_on ()

Public Attributes

GravityMode gravity_mode = NoGravity
Tscal tol = 1e-6
 Convergence tolerance of the Poisson solver.
Tscal tol_hp_bk = 1e-6
 Tolerance of the BiCGSTAB lucky breakdown test (restarts the solver below it).
u32 Niter_max = 100
 Maximum number of iterations of the Poisson solver.

Detailed Description

template<class Tvec>
struct shammodels::basegodunov::GravityConfig< Tvec >

Definition at line 88 of file SolverConfig.hpp.

Member Typedef Documentation

◆ Tscal

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

Definition at line 89 of file SolverConfig.hpp.

Member Function Documentation

◆ get_tolerance()

template<class Tvec>
Tscal shammodels::basegodunov::GravityConfig< Tvec >::get_tolerance ( )
inline

Definition at line 97 of file SolverConfig.hpp.

◆ is_gravity_on()

template<class Tvec>
bool shammodels::basegodunov::GravityConfig< Tvec >::is_gravity_on ( )
inline

Definition at line 98 of file SolverConfig.hpp.

Member Data Documentation

◆ gravity_mode

template<class Tvec>
GravityMode shammodels::basegodunov::GravityConfig< Tvec >::gravity_mode = NoGravity

Definition at line 90 of file SolverConfig.hpp.

◆ Niter_max

template<class Tvec>
u32 shammodels::basegodunov::GravityConfig< Tvec >::Niter_max = 100

Maximum number of iterations of the Poisson solver.

Definition at line 96 of file SolverConfig.hpp.

◆ tol

template<class Tvec>
Tscal shammodels::basegodunov::GravityConfig< Tvec >::tol = 1e-6

Convergence tolerance of the Poisson solver.

Definition at line 92 of file SolverConfig.hpp.

◆ tol_hp_bk

template<class Tvec>
Tscal shammodels::basegodunov::GravityConfig< Tvec >::tol_hp_bk = 1e-6

Tolerance of the BiCGSTAB lucky breakdown test (restarts the solver below it).

Definition at line 94 of file SolverConfig.hpp.


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