Plugins
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
ug::d3f::StVenantElemDiscFactory< TDomain > Class Template Reference

Factory class to construct and link the coupled St. Venant equations. More...

#include <st_venant_elem_disc.h>

Public Types

typedef ConstantSohlGradient< TDomain > s_type
 
typedef IElemDisc< TDomain > TElemDisc
 
typedef InverseLinker< dim > TInverseLinker
 
typedef CplUserData< number, dim > TNumberData
 
typedef EdgeOrientation< TDomain > TOrient
 
typedef ScaleAddLinker< number, dim, number > TScaleAddLinkerNumber
 
typedef ScaleAddLinker< MathVector< dim >, dim, number > TScaleAddLinkerVector
 
typedef StVenantElemDisc< TDomain > TStVenant
 
typedef ConvectionShapesFullUpwind< dim > TUpwind
 
typedef CplUserData< MathVector< dim >, dim > TVectorData
 

Public Member Functions

std::vector< SmartPtr< TStVenant > > create_1d_swe (const char *subsets)
 Creates the elemental discretizations for the 1D Shallow Water Equations.
 
SmartPtr< TScaleAddLinkerNumber > export_flux ()
 
SmartPtr< TNumberData > export_manning_roughness ()
 
SmartPtr< s_type > export_sohle ()
 
SmartPtr< TVectorData > export_v_flux_term ()
 
SmartPtr< TScaleAddLinkerNumber > export_velocity ()
 
SmartPtr< TNumberData > get_boundary_dir ()
 
const char * get_disc_type ()
 
SmartPtr< TNumberData > get_neumann_A ()
 
SmartPtr< TNumberData > get_neumann_V ()
 
SmartPtr< TScaleAddLinkerNumber > get_source_term ()
 
void set_b (SmartPtr< TNumberData > b)
 
void set_diffusion (number nu)
 
void set_domain (SmartPtr< TDomain > domain)
 
void set_gravity (number g)
 
void set_h_threshold (number t)
 
void set_ks (SmartPtr< TNumberData > ks)
 
void set_width (SmartPtr< TNumberData > b)
 
 StVenantElemDiscFactory ()
 
virtual ~StVenantElemDiscFactory ()=default
 

Static Public Attributes

static const int dim = TDomain::dim
 

Protected Attributes

SmartPtr< TNumberData > m_A_neumann
 
SmartPtr< TScaleAddLinkerVector > m_A_velocity = make_sp<TScaleAddLinkerVector>(new TScaleAddLinkerVector())
 
SmartPtr< TNumberData > m_b = make_sp<TNumberData>(new ConstUserNumber<dim>(1.0))
 
SmartPtr< TNumberData > m_boundary_dir
 
number m_diffusion = 0.5
 
SmartPtr< TDomain > m_domain
 
SmartPtr< TNumberData > m_frictionKs = make_sp<TNumberData>(new ConstUserNumber<dim>(0.1))
 
std::vector< std::string > m_functions
 
number m_gravity = 9.81
 
SmartPtr< TNumberData > m_manningRoughness
 
SmartPtr< s_type > m_s
 
number m_threshold = 1e-5
 
SmartPtr< TScaleAddLinkerNumber > m_total_source_term
 
SmartPtr< TUpwind > m_upwind = make_sp<TUpwind>(new TUpwind())
 
SmartPtr< TScaleAddLinkerNumber > m_v_05 = make_sp<TScaleAddLinkerNumber>(new TScaleAddLinkerNumber())
 
SmartPtr< TScaleAddLinkerVector > m_v_flux = make_sp<TScaleAddLinkerVector>(new TScaleAddLinkerVector())
 
SmartPtr< TVectorData > m_v_flux_term
 
SmartPtr< TScaleAddLinkerNumber > m_v_gsh = make_sp<TScaleAddLinkerNumber>(new TScaleAddLinkerNumber())
 
SmartPtr< TNumberData > m_v_neumann
 
SmartPtr< TScaleAddLinkerVector > m_v_velocity = make_sp<TScaleAddLinkerVector>(new TScaleAddLinkerVector())
 

Detailed Description

template<typename TDomain>
class ug::d3f::StVenantElemDiscFactory< TDomain >

Factory class to construct and link the coupled St. Venant equations.

Member Typedef Documentation

◆ s_type

template<typename TDomain >
typedef ConstantSohlGradient<TDomain> ug::d3f::StVenantElemDiscFactory< TDomain >::s_type

◆ TElemDisc

template<typename TDomain >
typedef IElemDisc<TDomain> ug::d3f::StVenantElemDiscFactory< TDomain >::TElemDisc

◆ TInverseLinker

template<typename TDomain >
typedef InverseLinker<dim> ug::d3f::StVenantElemDiscFactory< TDomain >::TInverseLinker

◆ TNumberData

template<typename TDomain >
typedef CplUserData<number, dim> ug::d3f::StVenantElemDiscFactory< TDomain >::TNumberData

◆ TOrient

template<typename TDomain >
typedef EdgeOrientation<TDomain> ug::d3f::StVenantElemDiscFactory< TDomain >::TOrient

◆ TScaleAddLinkerNumber

template<typename TDomain >
typedef ScaleAddLinker<number, dim, number> ug::d3f::StVenantElemDiscFactory< TDomain >::TScaleAddLinkerNumber

◆ TScaleAddLinkerVector

template<typename TDomain >
typedef ScaleAddLinker<MathVector<dim>, dim, number> ug::d3f::StVenantElemDiscFactory< TDomain >::TScaleAddLinkerVector

◆ TStVenant

template<typename TDomain >
typedef StVenantElemDisc<TDomain> ug::d3f::StVenantElemDiscFactory< TDomain >::TStVenant

◆ TUpwind

template<typename TDomain >
typedef ConvectionShapesFullUpwind<dim> ug::d3f::StVenantElemDiscFactory< TDomain >::TUpwind

◆ TVectorData

template<typename TDomain >
typedef CplUserData<MathVector<dim>, dim> ug::d3f::StVenantElemDiscFactory< TDomain >::TVectorData

Constructor & Destructor Documentation

◆ StVenantElemDiscFactory()

template<typename TDomain >
ug::d3f::StVenantElemDiscFactory< TDomain >::StVenantElemDiscFactory ( )
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_diffusion, ug::d3f::StVenantElemDiscFactory< TDomain >::m_functions, and ug::d3f::StVenantElemDiscFactory< TDomain >::m_gravity.

◆ ~StVenantElemDiscFactory()

template<typename TDomain >
virtual ug::d3f::StVenantElemDiscFactory< TDomain >::~StVenantElemDiscFactory ( )
virtualdefault

Member Function Documentation

◆ create_1d_swe()

template<typename TDomain >
std::vector< SmartPtr< TStVenant > > ug::d3f::StVenantElemDiscFactory< TDomain >::create_1d_swe ( const char *  subsets)
inline

Creates the elemental discretizations for the 1D Shallow Water Equations.

  • Parameters
    subsetsThe domain subsets to apply these equations to (e.g., "River").
    Returns
    std::vector<SmartPtr<TStVenant>> Containing the discretizations for [A, v].

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_b, ug::d3f::StVenantElemDiscFactory< TDomain >::m_boundary_dir, ug::d3f::StVenantElemDiscFactory< TDomain >::m_diffusion, ug::d3f::StVenantElemDiscFactory< TDomain >::m_domain, ug::d3f::StVenantElemDiscFactory< TDomain >::m_frictionKs, ug::d3f::StVenantElemDiscFactory< TDomain >::m_functions, ug::d3f::StVenantElemDiscFactory< TDomain >::m_gravity, ug::d3f::StVenantElemDiscFactory< TDomain >::m_manningRoughness, ug::d3f::StVenantElemDiscFactory< TDomain >::m_s, ug::d3f::StVenantElemDiscFactory< TDomain >::m_v_flux_term, make_sp(), and UG_LOG.

◆ export_flux()

template<typename TDomain >
SmartPtr< TScaleAddLinkerNumber > ug::d3f::StVenantElemDiscFactory< TDomain >::export_flux ( )
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_v_gsh.

◆ export_manning_roughness()

template<typename TDomain >
SmartPtr< TNumberData > ug::d3f::StVenantElemDiscFactory< TDomain >::export_manning_roughness ( )
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_manningRoughness.

◆ export_sohle()

template<typename TDomain >
SmartPtr< s_type > ug::d3f::StVenantElemDiscFactory< TDomain >::export_sohle ( )
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_s.

◆ export_v_flux_term()

template<typename TDomain >
SmartPtr< TVectorData > ug::d3f::StVenantElemDiscFactory< TDomain >::export_v_flux_term ( )
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_v_flux_term.

◆ export_velocity()

template<typename TDomain >
SmartPtr< TScaleAddLinkerNumber > ug::d3f::StVenantElemDiscFactory< TDomain >::export_velocity ( )
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_v_05.

◆ get_boundary_dir()

template<typename TDomain >
SmartPtr< TNumberData > ug::d3f::StVenantElemDiscFactory< TDomain >::get_boundary_dir ( )
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_boundary_dir.

◆ get_disc_type()

template<typename TDomain >
const char * ug::d3f::StVenantElemDiscFactory< TDomain >::get_disc_type ( )
inline

◆ get_neumann_A()

template<typename TDomain >
SmartPtr< TNumberData > ug::d3f::StVenantElemDiscFactory< TDomain >::get_neumann_A ( )
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_A_neumann.

◆ get_neumann_V()

template<typename TDomain >
SmartPtr< TNumberData > ug::d3f::StVenantElemDiscFactory< TDomain >::get_neumann_V ( )
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_v_neumann.

◆ get_source_term()

template<typename TDomain >
SmartPtr< TScaleAddLinkerNumber > ug::d3f::StVenantElemDiscFactory< TDomain >::get_source_term ( )
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_total_source_term.

◆ set_b()

template<typename TDomain >
void ug::d3f::StVenantElemDiscFactory< TDomain >::set_b ( SmartPtr< TNumberData >  b)
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_b.

◆ set_diffusion()

template<typename TDomain >
void ug::d3f::StVenantElemDiscFactory< TDomain >::set_diffusion ( number  nu)
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_diffusion.

◆ set_domain()

template<typename TDomain >
void ug::d3f::StVenantElemDiscFactory< TDomain >::set_domain ( SmartPtr< TDomain >  domain)
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_domain.

◆ set_gravity()

template<typename TDomain >
void ug::d3f::StVenantElemDiscFactory< TDomain >::set_gravity ( number  g)
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_gravity.

◆ set_h_threshold()

template<typename TDomain >
void ug::d3f::StVenantElemDiscFactory< TDomain >::set_h_threshold ( number  t)
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_threshold.

◆ set_ks()

template<typename TDomain >
void ug::d3f::StVenantElemDiscFactory< TDomain >::set_ks ( SmartPtr< TNumberData >  ks)
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_frictionKs.

◆ set_width()

template<typename TDomain >
void ug::d3f::StVenantElemDiscFactory< TDomain >::set_width ( SmartPtr< TNumberData >  b)
inline

References ug::d3f::StVenantElemDiscFactory< TDomain >::m_b.

Member Data Documentation

◆ dim

template<typename TDomain >
const int ug::d3f::StVenantElemDiscFactory< TDomain >::dim = TDomain::dim
static

◆ m_A_neumann

template<typename TDomain >
SmartPtr<TNumberData> ug::d3f::StVenantElemDiscFactory< TDomain >::m_A_neumann
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::get_neumann_A().

◆ m_A_velocity

template<typename TDomain >
SmartPtr<TScaleAddLinkerVector> ug::d3f::StVenantElemDiscFactory< TDomain >::m_A_velocity = make_sp<TScaleAddLinkerVector>(new TScaleAddLinkerVector())
protected

◆ m_b

template<typename TDomain >
SmartPtr<TNumberData> ug::d3f::StVenantElemDiscFactory< TDomain >::m_b = make_sp<TNumberData>(new ConstUserNumber<dim>(1.0))
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::create_1d_swe(), ug::d3f::StVenantElemDiscFactory< TDomain >::set_b(), and ug::d3f::StVenantElemDiscFactory< TDomain >::set_width().

◆ m_boundary_dir

template<typename TDomain >
SmartPtr<TNumberData> ug::d3f::StVenantElemDiscFactory< TDomain >::m_boundary_dir
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::create_1d_swe(), and ug::d3f::StVenantElemDiscFactory< TDomain >::get_boundary_dir().

◆ m_diffusion

template<typename TDomain >
number ug::d3f::StVenantElemDiscFactory< TDomain >::m_diffusion = 0.5
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::create_1d_swe(), ug::d3f::StVenantElemDiscFactory< TDomain >::set_diffusion(), and ug::d3f::StVenantElemDiscFactory< TDomain >::StVenantElemDiscFactory().

◆ m_domain

template<typename TDomain >
SmartPtr<TDomain> ug::d3f::StVenantElemDiscFactory< TDomain >::m_domain
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::create_1d_swe(), and ug::d3f::StVenantElemDiscFactory< TDomain >::set_domain().

◆ m_frictionKs

template<typename TDomain >
SmartPtr<TNumberData> ug::d3f::StVenantElemDiscFactory< TDomain >::m_frictionKs = make_sp<TNumberData>(new ConstUserNumber<dim>(0.1))
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::create_1d_swe(), and ug::d3f::StVenantElemDiscFactory< TDomain >::set_ks().

◆ m_functions

template<typename TDomain >
std::vector<std::string> ug::d3f::StVenantElemDiscFactory< TDomain >::m_functions
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::create_1d_swe(), and ug::d3f::StVenantElemDiscFactory< TDomain >::StVenantElemDiscFactory().

◆ m_gravity

template<typename TDomain >
number ug::d3f::StVenantElemDiscFactory< TDomain >::m_gravity = 9.81
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::create_1d_swe(), ug::d3f::StVenantElemDiscFactory< TDomain >::set_gravity(), and ug::d3f::StVenantElemDiscFactory< TDomain >::StVenantElemDiscFactory().

◆ m_manningRoughness

template<typename TDomain >
SmartPtr<TNumberData> ug::d3f::StVenantElemDiscFactory< TDomain >::m_manningRoughness
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::create_1d_swe(), and ug::d3f::StVenantElemDiscFactory< TDomain >::export_manning_roughness().

◆ m_s

template<typename TDomain >
SmartPtr<s_type> ug::d3f::StVenantElemDiscFactory< TDomain >::m_s
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::create_1d_swe(), and ug::d3f::StVenantElemDiscFactory< TDomain >::export_sohle().

◆ m_threshold

template<typename TDomain >
number ug::d3f::StVenantElemDiscFactory< TDomain >::m_threshold = 1e-5
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::set_h_threshold().

◆ m_total_source_term

template<typename TDomain >
SmartPtr<TScaleAddLinkerNumber> ug::d3f::StVenantElemDiscFactory< TDomain >::m_total_source_term
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::get_source_term().

◆ m_upwind

template<typename TDomain >
SmartPtr<TUpwind> ug::d3f::StVenantElemDiscFactory< TDomain >::m_upwind = make_sp<TUpwind>(new TUpwind())
protected

◆ m_v_05

template<typename TDomain >
SmartPtr<TScaleAddLinkerNumber> ug::d3f::StVenantElemDiscFactory< TDomain >::m_v_05 = make_sp<TScaleAddLinkerNumber>(new TScaleAddLinkerNumber())
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::export_velocity().

◆ m_v_flux

template<typename TDomain >
SmartPtr<TScaleAddLinkerVector> ug::d3f::StVenantElemDiscFactory< TDomain >::m_v_flux = make_sp<TScaleAddLinkerVector>(new TScaleAddLinkerVector())
protected

◆ m_v_flux_term

template<typename TDomain >
SmartPtr<TVectorData> ug::d3f::StVenantElemDiscFactory< TDomain >::m_v_flux_term
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::create_1d_swe(), and ug::d3f::StVenantElemDiscFactory< TDomain >::export_v_flux_term().

◆ m_v_gsh

template<typename TDomain >
SmartPtr<TScaleAddLinkerNumber> ug::d3f::StVenantElemDiscFactory< TDomain >::m_v_gsh = make_sp<TScaleAddLinkerNumber>(new TScaleAddLinkerNumber())
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::export_flux().

◆ m_v_neumann

template<typename TDomain >
SmartPtr<TNumberData> ug::d3f::StVenantElemDiscFactory< TDomain >::m_v_neumann
protected

Referenced by ug::d3f::StVenantElemDiscFactory< TDomain >::get_neumann_V().

◆ m_v_velocity

template<typename TDomain >
SmartPtr<TScaleAddLinkerVector> ug::d3f::StVenantElemDiscFactory< TDomain >::m_v_velocity = make_sp<TScaleAddLinkerVector>(new TScaleAddLinkerVector())
protected
The documentation for this class was generated from the following file: