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::VTKDump< Tvec, SPHKernel > Class Template Reference

Module for writing VTK format output files. More...

#include <shammodels/sph/include/shammodels/sph/modules/io/VTKDump.hpp>

+ Collaboration diagram for shammodels::sph::modules::VTKDump< 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

 VTKDump (ShamrockCtx &context, Config &solver_config)
 
void do_dump (std::string filename, bool add_patch_world_id)
 Writes particle data to VTK file for visualization.
 

Public Attributes

ShamrockCtxcontext
 
Configsolver_config
 

Static Public Attributes

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

Detailed Description

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

Module for writing VTK format output files.

Template Parameters
TvecVector type for positions
SPHKernelSPH kernel template

Definition at line 33 of file VTKDump.hpp.

Member Typedef Documentation

◆ Config

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

Definition at line 39 of file VTKDump.hpp.

◆ Kernel

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

Definition at line 37 of file VTKDump.hpp.

◆ Storage

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

Definition at line 40 of file VTKDump.hpp.

◆ Tscal

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

Definition at line 35 of file VTKDump.hpp.

Constructor & Destructor Documentation

◆ VTKDump()

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

Definition at line 45 of file VTKDump.hpp.

Member Function Documentation

◆ do_dump()

template<class Tvec , template< class > class SPHKernel>
void shammodels::sph::modules::VTKDump< Tvec, SPHKernel >::do_dump ( std::string  filename,
bool  add_patch_world_id 
)

Writes particle data to VTK file for visualization.

Definition at line 37 of file VTKDump.cpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ context

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

Definition at line 42 of file VTKDump.hpp.

◆ dim

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

Definition at line 36 of file VTKDump.hpp.

◆ solver_config

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

Definition at line 43 of file VTKDump.hpp.


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