fub::Advection2d Struct Reference

This class descibes the 2-dimensional advection equation with constant transport velocity. More...

#include <Advection.hpp>

Public Types
using	ConservativeDepths = AdvectionVariables< ScalarDepth >
using	CompleteDepths = ConservativeDepths
using	Complete = ::fub::Complete< Advection2d >
using	Conservative = ::fub::Conservative< Advection2d >
using	CompleteArray = ::fub::CompleteArray< Advection2d >
using	ConservativeArray = ::fub::ConservativeArray< Advection2d >

Public Member Functions
	Advection2d (const std::array< double, 2 > &v) noexcept
	Constructs an equation object with velocity v. More...
void	Flux (Conservative &flux, const Complete &state, Direction dir) const noexcept
	Computes the linear transport flux in the specified direction. More...
void	Flux (ConservativeArray &flux, const CompleteArray &state, Direction dir) const noexcept
	Computes the linear transport flux in the specified direction (Array version). More...

Static Public Member Functions
static constexpr int	Rank ()
	Returns 2, which is the space dimension for this equation. More...

Public Attributes
std::array< double, 2 >	velocity
	This member variable stores the constant transport velocity. More...

Detailed Description

This class descibes the 2-dimensional advection equation with constant transport velocity.

Member Typedef Documentation

Complete

using fub::Advection2d::Complete = ::fub::Complete<Advection2d>

CompleteArray

using fub::Advection2d::CompleteArray = ::fub::CompleteArray<Advection2d>

CompleteDepths

using fub::Advection2d::CompleteDepths = ConservativeDepths

Conservative

using fub::Advection2d::Conservative = ::fub::Conservative<Advection2d>

ConservativeArray

using fub::Advection2d::ConservativeArray = ::fub::ConservativeArray<Advection2d>

ConservativeDepths

using fub::Advection2d::ConservativeDepths = AdvectionVariables<ScalarDepth>

Constructor & Destructor Documentation

Advection2d()

fub::Advection2d::Advection2d ( const std::array< double, 2 > &  v )

inlinenoexcept

Constructs an equation object with velocity v.

Member Function Documentation

Flux() [1/2]

void fub::Advection2d::Flux ( Conservative &  flux, const Complete &  state, Direction  dir  ) const

noexcept

Computes the linear transport flux in the specified direction.

Parameters

[out]	flux	The conservative state which will store the results.
[in]	state	The input state.
[in]	dir	The split direction of this flux.

Flux() [2/2]

void fub::Advection2d::Flux ( ConservativeArray &  flux, const CompleteArray &  state, Direction  dir  ) const

noexcept

Computes the linear transport flux in the specified direction (Array version).

Parameters

[out]	flux	The conservative state which will store the results.
[in]	state	The input state.
[in]	dir	The split direction of this flux.

Rank()

static constexpr int fub::Advection2d::Rank ( )

inlinestaticconstexpr

Returns 2, which is the space dimension for this equation.

Member Data Documentation

velocity

std::array<double, 2> fub::Advection2d::velocity

This member variable stores the constant transport velocity.

---

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

• Advection.hpp