ryujin 2.1.1 revision d1a5601757449924e68a428cfd892dfe8915810d
Public Types | Public Member Functions | List of all members
ryujin::ShallowWaterInitialStates::GeoTIFF< Description, dim, Number > Class Template Reference

#include <source/shallow_water/initial_state_geotiff.h>

Inheritance diagram for ryujin::ShallowWaterInitialStates::GeoTIFF< Description, dim, Number >:
Inheritance graph
[legend]
Collaboration diagram for ryujin::ShallowWaterInitialStates::GeoTIFF< Description, dim, Number >:
Collaboration graph
[legend]

Public Types

using HyperbolicSystem = typename Description::HyperbolicSystem
 
using View = typename Description::template HyperbolicSystemView< dim, Number >
 
using state_type = typename View::state_type
 
- Public Types inherited from ryujin::InitialState< Description, dim, Number >
using View = typename Description::template HyperbolicSystemView< dim, Number >
 
using state_type = typename View::state_type
 
using initial_precomputed_type = typename View::initial_precomputed_type
 

Public Member Functions

 GeoTIFF (const HyperbolicSystem &hyperbolic_system, const std::string subsection)
 
state_type compute (const dealii::Point< dim > &point, Number t) final
 
auto initial_precomputations (const dealii::Point< dim > &point) -> typename InitialState< Description, dim, Number >::initial_precomputed_type final
 
- Public Member Functions inherited from ryujin::InitialState< Description, dim, Number >
 InitialState (const std::string &name, const std::string &subsection)
 
virtual state_type compute (const dealii::Point< dim > &point, Number t)=0
 
virtual initial_precomputed_type initial_precomputations (const dealii::Point< dim > &)
 
auto & name () const
 

Detailed Description

template<typename Description, int dim, typename Number>
class ryujin::ShallowWaterInitialStates::GeoTIFF< Description, dim, Number >

Returns an initial state by reading a bathymetry from a geotiff file. For this we link against GDAL, see https://gdal.org/index.html for details on GDAL and what image formats it supports.

Definition at line 32 of file initial_state_geotiff.h.

Member Typedef Documentation

◆ HyperbolicSystem

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

Definition at line 35 of file initial_state_geotiff.h.

◆ View

template<typename Description , int dim, typename Number >
using ryujin::ShallowWaterInitialStates::GeoTIFF< Description, dim, Number >::View = typename Description::template HyperbolicSystemView<dim, Number>

Definition at line 36 of file initial_state_geotiff.h.

◆ state_type

template<typename Description , int dim, typename Number >
using ryujin::ShallowWaterInitialStates::GeoTIFF< Description, dim, Number >::state_type = typename View::state_type

Definition at line 38 of file initial_state_geotiff.h.

Constructor & Destructor Documentation

◆ GeoTIFF()

template<typename Description , int dim, typename Number >
ryujin::ShallowWaterInitialStates::GeoTIFF< Description, dim, Number >::GeoTIFF ( const HyperbolicSystem hyperbolic_system,
const std::string  subsection 
)
inline

Definition at line 41 of file initial_state_geotiff.h.

Member Function Documentation

◆ compute()

template<typename Description , int dim, typename Number >
state_type ryujin::ShallowWaterInitialStates::GeoTIFF< Description, dim, Number >::compute ( const dealii::Point< dim > &  point,
Number  t 
)
inlinefinalvirtual

Given a position point returns the corresponding (conserved) initial state. The function is used to interpolate initial values and enforce Dirichlet boundary conditions. For the latter, the function signature has an additional parameter t denoting the current time to allow for time-dependent (in-flow) Dirichlet data.

Implements ryujin::InitialState< Description, dim, Number >.

Definition at line 117 of file initial_state_geotiff.h.

◆ initial_precomputations()

template<typename Description , int dim, typename Number >
auto ryujin::ShallowWaterInitialStates::GeoTIFF< Description, dim, Number >::initial_precomputations ( const dealii::Point< dim > &  ) -> typename InitialState<Description, dim, Number>:: initial_precomputed_type
inlinefinalvirtual

Given a position point returns a precomputed value used for the flux computation via HyperbolicSystem::flux_contribution().

The default implementation of this function simply returns a zero value. In case of the The Shallow Water Equations we pre-compute the bathymetry. In case of LinearTransport we precompute the advection field.

Reimplemented from ryujin::InitialState< Description, dim, Number >.

Definition at line 133 of file initial_state_geotiff.h.


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