ViennaLS
Loading...
Searching...
No Matches
viennals::VelocityField< T > Class Template Reference

Abstract class defining the interface for the velocity field used during advection using lsAdvect. More...

#include <lsVelocityField.hpp>

Inherited by PylsVelocityField.

Public Member Functions

 VelocityField ()
 
virtual T getScalarVelocity (const Vec3D< T > &, int, const Vec3D< T > &, unsigned long)
 Should return a scalar value for the velocity at coordinate for a point of material with the given normalVector.
 
virtual Vec3D< TgetVectorVelocity (const Vec3D< T > &, int, const Vec3D< T > &, unsigned long)
 Like getScalarVelocity, but returns a velocity value for each cartesian direction.
 
virtual T getDissipationAlpha (int, int, const Vec3D< T > &)
 If lsLocalLaxFriedrichsAnalytical is used as the advection scheme, this is called to provide the analytical solution for the alpha values, needed for stable integration.
 
virtual ~VelocityField ()
 

Detailed Description

template<class T>
class viennals::VelocityField< T >

Abstract class defining the interface for the velocity field used during advection using lsAdvect.

Constructor & Destructor Documentation

◆ VelocityField()

template<class T >
viennals::VelocityField< T >::VelocityField ( )
inline

◆ ~VelocityField()

template<class T >
virtual viennals::VelocityField< T >::~VelocityField ( )
inlinevirtual

Member Function Documentation

◆ getDissipationAlpha()

template<class T >
virtual T viennals::VelocityField< T >::getDissipationAlpha ( int ,
int ,
const Vec3D< T > &  )
inlinevirtual

If lsLocalLaxFriedrichsAnalytical is used as the advection scheme, this is called to provide the analytical solution for the alpha values, needed for stable integration.

◆ getScalarVelocity()

template<class T >
virtual T viennals::VelocityField< T >::getScalarVelocity ( const Vec3D< T > & ,
int ,
const Vec3D< T > & ,
unsigned long  )
inlinevirtual

Should return a scalar value for the velocity at coordinate for a point of material with the given normalVector.

◆ getVectorVelocity()

template<class T >
virtual Vec3D< T > viennals::VelocityField< T >::getVectorVelocity ( const Vec3D< T > & ,
int ,
const Vec3D< T > & ,
unsigned long  )
inlinevirtual

Like getScalarVelocity, but returns a velocity value for each cartesian direction.


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