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.
Public Member Functions | Protected Member Functions | List of all members
Kratos::TimeDiscretization::BDF Class Reference

#include <time_discretization.h>

Inheritance diagram for Kratos::TimeDiscretization::BDF:
Collaboration diagram for Kratos::TimeDiscretization::BDF:

Public Member Functions

 KRATOS_CLASS_POINTER_DEFINITION (BDF)
 
 BDF (const unsigned int TimeOrder)
 Construct a new BDF object Constructor with time order. More...
 
virtual ~BDF ()=default
 Destroy the BDF object Destructor of the BDF class. More...
 
virtual std::vector< doubleComputeBDFCoefficients (double DeltaTime) const
 Return the BDF coefficients This method computes the BDF coefficients for a provided time step. More...
 
virtual std::vector< doubleComputeBDFCoefficients (double DeltaTime, double PreviousDeltaTime) const
 Return the BDF coefficients This method computes the BDF coefficients for a provided current and old time step. More...
 
virtual std::vector< doubleComputeBDFCoefficients (const ProcessInfo &rProcessInfo) const
 Return the BDF coefficients This method computes the BDF coefficients for the time step stored in the variable DELTA_TIME of a ProcessInfo container. More...
 
void ComputeAndSaveBDFCoefficients (ProcessInfo &rProcessInfo) const
 Computes the BDF coefficients This method computes the BDF coefficients with the information stored in the provided ProcessInfo. The computed coefficients are saved in such ProcessInfo container. More...
 
std::size_t GetTimeOrder () const
 Get the Time Order object Auxiliary method to get the order of the BDF scheme. More...
 

Protected Member Functions

 BDF ()
 Construct a new BDF object Auxiliary constructor for derived classes. More...
 

Constructor & Destructor Documentation

◆ BDF() [1/2]

Kratos::TimeDiscretization::BDF::BDF ( const unsigned int  TimeOrder)
inline

Construct a new BDF object Constructor with time order.

Parameters
TimeOrderBDF time order

◆ ~BDF()

virtual Kratos::TimeDiscretization::BDF::~BDF ( )
virtualdefault

Destroy the BDF object Destructor of the BDF class.

◆ BDF() [2/2]

Kratos::TimeDiscretization::BDF::BDF ( )
inlineprotected

Construct a new BDF object Auxiliary constructor for derived classes.

Member Function Documentation

◆ ComputeAndSaveBDFCoefficients()

void Kratos::TimeDiscretization::BDF::ComputeAndSaveBDFCoefficients ( ProcessInfo rProcessInfo) const

Computes the BDF coefficients This method computes the BDF coefficients with the information stored in the provided ProcessInfo. The computed coefficients are saved in such ProcessInfo container.

Parameters
rProcessInfoProcessInfo container with DELTA_TIME

◆ ComputeBDFCoefficients() [1/3]

std::vector< double > Kratos::TimeDiscretization::BDF::ComputeBDFCoefficients ( const ProcessInfo rProcessInfo) const
virtual

Return the BDF coefficients This method computes the BDF coefficients for the time step stored in the variable DELTA_TIME of a ProcessInfo container.

Parameters
rProcessInfoProcessInfo container with DELTA_TIME
Returns
std::vector<double> Vector containing the computed BDF coefficients

Reimplemented in Kratos::TimeDiscretization::BDF6, Kratos::TimeDiscretization::BDF5, Kratos::TimeDiscretization::BDF4, Kratos::TimeDiscretization::BDF3, Kratos::TimeDiscretization::BDF2, and Kratos::TimeDiscretization::BDF1.

◆ ComputeBDFCoefficients() [2/3]

std::vector< double > Kratos::TimeDiscretization::BDF::ComputeBDFCoefficients ( double  DeltaTime) const
virtual

Return the BDF coefficients This method computes the BDF coefficients for a provided time step.

Parameters
DeltaTimeTime step to compute the BDF coefficients
Returns
std::vector<double> Vector containing the computed BDF coefficients

Reimplemented in Kratos::TimeDiscretization::BDF6, Kratos::TimeDiscretization::BDF5, Kratos::TimeDiscretization::BDF4, Kratos::TimeDiscretization::BDF3, and Kratos::TimeDiscretization::BDF1.

◆ ComputeBDFCoefficients() [3/3]

std::vector< double > Kratos::TimeDiscretization::BDF::ComputeBDFCoefficients ( double  DeltaTime,
double  PreviousDeltaTime 
) const
virtual

Return the BDF coefficients This method computes the BDF coefficients for a provided current and old time step.

Parameters
DeltaTimeTime step to compute the BDF coefficients
PreviousDeltaTimeOld time step to compute the BDF coefficients
Returns
std::vector<double> Vector containing the computed BDF coefficients

Reimplemented in Kratos::TimeDiscretization::BDF2.

◆ GetTimeOrder()

std::size_t Kratos::TimeDiscretization::BDF::GetTimeOrder ( ) const

Get the Time Order object Auxiliary method to get the order of the BDF scheme.

Returns
const std::size_t Order of the BDF scheme

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::TimeDiscretization::BDF::KRATOS_CLASS_POINTER_DEFINITION ( BDF  )

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