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.
List of all members
Kratos::FlowStationarityCheck Class Reference

This defines a class to assess whether stationarity has been reached in the fluid. More...

#include <stationarity_check.h>

Collaboration diagram for Kratos::FlowStationarityCheck:

Public Member Functions

Type Definitions
 KRATOS_CLASS_POINTER_DEFINITION (FlowStationarityCheck)
 Pointer definition of FlowStationarityCheck. More...
 
Life Cycle
 FlowStationarityCheck (ModelPart &rFluidModelPart, const double tolerance)
 Default constructor. More...
 
 FlowStationarityCheck (FlowStationarityCheck const &rOther)=delete
 Copy constructor. More...
 
virtual ~FlowStationarityCheck ()=default
 Destructor. More...
 
Operators
FlowStationarityCheckoperator= (FlowStationarityCheck const &rOther)=delete
 Assignment operator. More...
 
Operations
bool AssessStationarity ()
 This function calculates the current time derivative average and compares it to the accumulated historical average. More...
 
double GetCharacteristicPressureDerivative ()
 
double GetCurrentPressureDerivative ()
 
double GetTolerance ()
 
double GetTransienceMeasure ()
 
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...
 

Detailed Description

This defines a class to assess whether stationarity has been reached in the fluid.

It compares a spacial and historically-averaged pressure time derivative to the current spacially averaged value

Author
Guillermo Casas

Constructor & Destructor Documentation

◆ FlowStationarityCheck() [1/2]

Kratos::FlowStationarityCheck::FlowStationarityCheck ( ModelPart rFluidModelPart,
const double  tolerance 
)
inline

Default constructor.

◆ FlowStationarityCheck() [2/2]

Kratos::FlowStationarityCheck::FlowStationarityCheck ( FlowStationarityCheck const &  rOther)
delete

Copy constructor.

◆ ~FlowStationarityCheck()

virtual Kratos::FlowStationarityCheck::~FlowStationarityCheck ( )
virtualdefault

Destructor.

Member Function Documentation

◆ AssessStationarity()

bool Kratos::FlowStationarityCheck::AssessStationarity ( )

This function calculates the current time derivative average and compares it to the accumulated historical average.

This function can be called every few fluid time steps an

Returns
true if the stationary state has been reached according to the chosen tolerance

◆ GetCharacteristicPressureDerivative()

double Kratos::FlowStationarityCheck::GetCharacteristicPressureDerivative ( )

◆ GetCurrentPressureDerivative()

double Kratos::FlowStationarityCheck::GetCurrentPressureDerivative ( )

◆ GetTolerance()

double Kratos::FlowStationarityCheck::GetTolerance ( )

◆ GetTransienceMeasure()

double Kratos::FlowStationarityCheck::GetTransienceMeasure ( )

◆ Info()

virtual std::string Kratos::FlowStationarityCheck::Info ( ) const
inlinevirtual

Turn back information as a string.

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::FlowStationarityCheck::KRATOS_CLASS_POINTER_DEFINITION ( FlowStationarityCheck  )

Pointer definition of FlowStationarityCheck.

◆ operator=()

FlowStationarityCheck& Kratos::FlowStationarityCheck::operator= ( FlowStationarityCheck const &  rOther)
delete

Assignment operator.

◆ PrintData()

virtual void Kratos::FlowStationarityCheck::PrintData ( std::ostream &  rOStream) const
inlinevirtual

Print object's data.

◆ PrintInfo()

virtual void Kratos::FlowStationarityCheck::PrintInfo ( std::ostream &  rOStream) const
inlinevirtual

Print information about this object.


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