Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel > Class Template Reference

Module for checking conservation of physical quantities. More...

#include <shammodels/sph/include/shammodels/sph/modules/ConservativeCheck.hpp>

+ Collaboration diagram for shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel >:

Public Types

using Tscal = shambase::VecComponent< Tvec >
 
using Kernel = SPHKernel< Tscal >
 
using Config = SolverConfig< Tvec, SPHKernel >
 
using Storage = SolverStorage< Tvec, u32 >
 

Public Member Functions

 ConservativeCheck (ShamrockCtx &context, Config &solver_config, Storage &storage)
 
void check_conservation ()
 Verifies conservation of mass, momentum, and energy.
 

Public Attributes

ShamrockCtxcontext
 
Configsolver_config
 
Storagestorage
 

Static Public Attributes

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

Detailed Description

template<class Tvec, template< class > class SPHKernel>
class shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel >

Module for checking conservation of physical quantities.

Template Parameters
TvecVector type for positions
SPHKernelSPH kernel template

Definition at line 33 of file ConservativeCheck.hpp.

Member Typedef Documentation

◆ Config

template<class Tvec , template< class > class SPHKernel>
using shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel >::Config = SolverConfig<Tvec, SPHKernel>

Definition at line 39 of file ConservativeCheck.hpp.

◆ Kernel

template<class Tvec , template< class > class SPHKernel>
using shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel >::Kernel = SPHKernel<Tscal>

Definition at line 37 of file ConservativeCheck.hpp.

◆ Storage

template<class Tvec , template< class > class SPHKernel>
using shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel >::Storage = SolverStorage<Tvec, u32>

Definition at line 40 of file ConservativeCheck.hpp.

◆ Tscal

template<class Tvec , template< class > class SPHKernel>
using shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel >::Tscal = shambase::VecComponent<Tvec>

Definition at line 35 of file ConservativeCheck.hpp.

Constructor & Destructor Documentation

◆ ConservativeCheck()

template<class Tvec , template< class > class SPHKernel>
shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel >::ConservativeCheck ( ShamrockCtx context,
Config solver_config,
Storage storage 
)
inline

Definition at line 46 of file ConservativeCheck.hpp.

Member Function Documentation

◆ check_conservation()

template<class Tvec , template< class > class SPHKernel>
void shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel >::check_conservation ( )

Verifies conservation of mass, momentum, and energy.

Definition at line 25 of file ConservativeCheck.cpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ context

template<class Tvec , template< class > class SPHKernel>
ShamrockCtx& shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel >::context

Definition at line 42 of file ConservativeCheck.hpp.

◆ dim

template<class Tvec , template< class > class SPHKernel>
constexpr u32 shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel >::dim = shambase::VectorProperties<Tvec>::dimension
staticconstexpr

Definition at line 36 of file ConservativeCheck.hpp.

◆ solver_config

template<class Tvec , template< class > class SPHKernel>
Config& shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel >::solver_config

Definition at line 43 of file ConservativeCheck.hpp.

◆ storage

template<class Tvec , template< class > class SPHKernel>
Storage& shammodels::sph::modules::ConservativeCheck< Tvec, SPHKernel >::storage

Definition at line 44 of file ConservativeCheck.hpp.


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