KratosMultiphysics
KRATOS Multiphysics (Kratos) is a framework for building parallel, multi-disciplinary simulation software, aiming at modularity, extensibility, and high performance. Kratos is written in C++, and counts with an extensive Python interface.
Classes | List of all members
Kratos::FluxLimiter< TLocalVectorType > Class Template Reference

This is a helper class to separate the physics from the flux corrected scheme. More...

#include <flux_limiter.h>

Collaboration diagram for Kratos::FluxLimiter< TLocalVectorType >:

Classes

struct  AllowableIncrements
 

Public Member Functions

Life Cycle
 FluxLimiter ()
 Default constructor. More...
 
 FluxLimiter (Parameters ThisParameters)
 Constructor with parameters. More...
 
 FluxLimiter (FluxLimiter const &rOther)
 Copy constructor. More...
 
virtual ~FluxLimiter ()
 Destructor. More...
 
Operations
IndexType size ()
 
double ComputeUnlimitedFlux (const TLocalVectorType &rContributions, const NodeType &rNode, IndexType iNode, IndexType iVar)
 
AllowableIncrements ComputeAllowableIncrements (const NodeType &rNode, IndexType iVar)
 
Input and output
virtual std::string Info () const
 Turn back information as a string. More...
 
virtual void PrintInfo (std::ostream &rOStream) const
 Print information about this object. More...
 
virtual void PrintData (std::ostream &rOStream) const
 Print object's data. More...
 

Type Definitions

typedef Node NodeType
 
typedef GlobalPointersVector< NodeGlobalPointersVectorType
 
 KRATOS_CLASS_POINTER_DEFINITION (FluxLimiter)
 

Detailed Description

template<class TLocalVectorType>
class Kratos::FluxLimiter< TLocalVectorType >

This is a helper class to separate the physics from the flux corrected scheme.

See also
FluxCorrectedShallowWaterScheme

Member Typedef Documentation

◆ GlobalPointersVectorType

template<class TLocalVectorType >
typedef GlobalPointersVector<Node> Kratos::FluxLimiter< TLocalVectorType >::GlobalPointersVectorType

◆ NodeType

template<class TLocalVectorType >
typedef Node Kratos::FluxLimiter< TLocalVectorType >::NodeType

Constructor & Destructor Documentation

◆ FluxLimiter() [1/3]

template<class TLocalVectorType >
Kratos::FluxLimiter< TLocalVectorType >::FluxLimiter ( )
inline

Default constructor.

◆ FluxLimiter() [2/3]

template<class TLocalVectorType >
Kratos::FluxLimiter< TLocalVectorType >::FluxLimiter ( Parameters  ThisParameters)
inline

Constructor with parameters.

◆ FluxLimiter() [3/3]

template<class TLocalVectorType >
Kratos::FluxLimiter< TLocalVectorType >::FluxLimiter ( FluxLimiter< TLocalVectorType > const &  rOther)
inline

Copy constructor.

◆ ~FluxLimiter()

template<class TLocalVectorType >
virtual Kratos::FluxLimiter< TLocalVectorType >::~FluxLimiter ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ ComputeAllowableIncrements()

template<class TLocalVectorType >
AllowableIncrements Kratos::FluxLimiter< TLocalVectorType >::ComputeAllowableIncrements ( const NodeType rNode,
IndexType  iVar 
)
inline

◆ ComputeUnlimitedFlux()

template<class TLocalVectorType >
double Kratos::FluxLimiter< TLocalVectorType >::ComputeUnlimitedFlux ( const TLocalVectorType &  rContributions,
const NodeType rNode,
IndexType  iNode,
IndexType  iVar 
)
inline

◆ Info()

template<class TLocalVectorType >
virtual std::string Kratos::FluxLimiter< TLocalVectorType >::Info ( ) const
inlinevirtual

Turn back information as a string.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TLocalVectorType >
Kratos::FluxLimiter< TLocalVectorType >::KRATOS_CLASS_POINTER_DEFINITION ( FluxLimiter< TLocalVectorType >  )

◆ PrintData()

template<class TLocalVectorType >
virtual void Kratos::FluxLimiter< TLocalVectorType >::PrintData ( std::ostream &  rOStream) const
inlinevirtual

Print object's data.

◆ PrintInfo()

template<class TLocalVectorType >
virtual void Kratos::FluxLimiter< TLocalVectorType >::PrintInfo ( std::ostream &  rOStream) const
inlinevirtual

Print information about this object.

◆ size()

template<class TLocalVectorType >
IndexType Kratos::FluxLimiter< TLocalVectorType >::size ( )
inline

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