ryujin 2.1.1 revision ee5cbcbf2346c1299c942d0e1f13b46449973c18
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
ryujin::SelectedComponentsExtractor< Description, dim, Number > Struct Template Reference

#include <source/selected_components_extractor.h>

Public Types

using HyperbolicSystem = typename Description::HyperbolicSystem
 
using ParabolicSystem = typename Description::ParabolicSystem
 
using View = typename HyperbolicSystem::template View< dim, Number >
 
using StateVector = typename View::StateVector
 
using InitialPrecomputedVector = typename View::InitialPrecomputedVector
 
using ScalarVector = Vectors::ScalarVector< Number >
 
using ScalarHostVector = Vectors::ScalarHostVector< Number >
 

Public Member Functions

 SelectedComponentsExtractor ()=delete
 

Static Public Member Functions

static void check (const std::vector< std::string > &parabolic_component_names, const std::vector< std::string > &additional_names, const std::vector< std::string > &selected)
 
static std::vector< ScalarHostVectorextract (const OfflineData< dim, Number > &offline_data, const HyperbolicSystem &hyperbolic_system, const ParabolicSystem &parabolic_system, const StateVector &state_vector, const InitialPrecomputedVector &initial_precomputed, const std::vector< std::string > &additional_names, const std::vector< std::reference_wrapper< const ScalarVector > > &additional_vectors, const std::vector< std::string > &selected)
 

Detailed Description

template<typename Description, int dim, typename Number>
struct ryujin::SelectedComponentsExtractor< Description, dim, Number >

A helper class that extracts a selection of named components from a state vector into a vector of scalar vectors suitable for output and postprocessing.

A component can be selected by any of its conserved, primitive, parabolic, precomputed, or initial-precomputed name, or by one of the additional names supplied by the caller.

Definition at line 26 of file selected_components_extractor.h.

Member Typedef Documentation

◆ HyperbolicSystem

template<typename Description , int dim, typename Number >
using ryujin::SelectedComponentsExtractor< Description, dim, Number >::HyperbolicSystem = typename Description::HyperbolicSystem

Definition at line 27 of file selected_components_extractor.h.

◆ ParabolicSystem

template<typename Description , int dim, typename Number >
using ryujin::SelectedComponentsExtractor< Description, dim, Number >::ParabolicSystem = typename Description::ParabolicSystem

Definition at line 28 of file selected_components_extractor.h.

◆ View

template<typename Description , int dim, typename Number >
using ryujin::SelectedComponentsExtractor< Description, dim, Number >::View = typename HyperbolicSystem::template View<dim, Number>

Definition at line 30 of file selected_components_extractor.h.

◆ StateVector

template<typename Description , int dim, typename Number >
using ryujin::SelectedComponentsExtractor< Description, dim, Number >::StateVector = typename View::StateVector

Definition at line 32 of file selected_components_extractor.h.

◆ InitialPrecomputedVector

template<typename Description , int dim, typename Number >
using ryujin::SelectedComponentsExtractor< Description, dim, Number >::InitialPrecomputedVector = typename View::InitialPrecomputedVector

Definition at line 33 of file selected_components_extractor.h.

◆ ScalarVector

template<typename Description , int dim, typename Number >
using ryujin::SelectedComponentsExtractor< Description, dim, Number >::ScalarVector = Vectors::ScalarVector<Number>

Definition at line 35 of file selected_components_extractor.h.

◆ ScalarHostVector

template<typename Description , int dim, typename Number >
using ryujin::SelectedComponentsExtractor< Description, dim, Number >::ScalarHostVector = Vectors::ScalarHostVector<Number>

Definition at line 36 of file selected_components_extractor.h.

Constructor & Destructor Documentation

◆ SelectedComponentsExtractor()

template<typename Description , int dim, typename Number >
ryujin::SelectedComponentsExtractor< Description, dim, Number >::SelectedComponentsExtractor ( )
delete

Member Function Documentation

◆ check()

template<typename Description , int dim, typename Number >
static void ryujin::SelectedComponentsExtractor< Description, dim, Number >::check ( const std::vector< std::string > &  parabolic_component_names,
const std::vector< std::string > &  additional_names,
const std::vector< std::string > &  selected 
)
inlinestatic

◆ extract()

template<typename Description , int dim, typename Number >
static std::vector< ScalarHostVector > ryujin::SelectedComponentsExtractor< Description, dim, Number >::extract ( const OfflineData< dim, Number > &  offline_data,
const HyperbolicSystem hyperbolic_system,
const ParabolicSystem parabolic_system,
const StateVector state_vector,
const InitialPrecomputedVector initial_precomputed,
const std::vector< std::string > &  additional_names,
const std::vector< std::reference_wrapper< const ScalarVector > > &  additional_vectors,
const std::vector< std::string > &  selected 
)
inlinestatic

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