timeintegration.h

Go to the documentation of this file.

 
#pragma once
 
// STL
#include <memory>
#include <string>
 
// PETSc headers
#include <petscsys.h>
 
// YAML CPP
#include <yaml-cpp/yaml.h>
 
// headers from PetIBM
#include <petibm/type.h>
 
namespace petibm
{
namespace timeintegration
{
class TimeIntegrationBase
{
public:
    const std::string name;
 
    const std::string scheme;
 
    const PetscReal implicitCoeff;
 
    const PetscInt nExplicit;
 
    const type::RealVec1D explicitCoeffs;
 
    TimeIntegrationBase() : TimeIntegrationBase("none", "none", 0.0, 0, {}){};
 
    TimeIntegrationBase(const std::string &inName, const std::string &inScheme,
                        const PetscReal &inImplicitCoeff,
                        const PetscInt &inNEcplicit,
                        const type::RealVec1D &inExplicitCoeffs)
        : name(inName),
          scheme(inScheme),
          implicitCoeff(inImplicitCoeff),
          nExplicit(inNEcplicit),
          explicitCoeffs(inExplicitCoeffs){};
 
    virtual ~TimeIntegrationBase() = default;
 
    PetscErrorCode printInfo() const;
 
};  // TimeIntegrationBase
 
class Euler_Explicit : public TimeIntegrationBase
{
public:
    Euler_Explicit(const std::string &name)
        : TimeIntegrationBase(name, "1st order explicit Euler", 0.0, 1,
                              {1.0}){};
 
    virtual ~Euler_Explicit() = default;
};  // Euler_Explicit
 
class Euler_Implicit : public TimeIntegrationBase
{
public:
    Euler_Implicit(const std::string &name)
        : TimeIntegrationBase(name, "1st order implicit Euler", 1.0, 0, {}){};
 
    virtual ~Euler_Implicit() = default;
};  // Euler_Implicit
 
class Adams_Bashforth_2 : public TimeIntegrationBase
{
public:
    Adams_Bashforth_2(const std::string &name)
        : TimeIntegrationBase(name, "2nd order Adams-Bashforth", 0.0, 2,
                              {1.5, -0.5}){};
 
    virtual ~Adams_Bashforth_2() = default;
};  // Adams_Bashforth_2
 
class Crank_Nicolson : public TimeIntegrationBase
{
public:
    Crank_Nicolson(const std::string &name)
        : TimeIntegrationBase(name, "2nd order Crank-Nicolson", 0.5, 1,
                              {0.5}){};
 
    virtual ~Crank_Nicolson() = default;
};  // Crank_Nicolson
 
}  // end of namespace timeintegration
 
namespace type
{
typedef std::shared_ptr<timeintegration::TimeIntegrationBase> TimeIntegration;
}  // end of namespace type
 
namespace timeintegration
{
PetscErrorCode createTimeIntegration(const std::string &name,
                                     const YAML::Node &node,
                                     type::TimeIntegration &integration);
}  // end of namespace timeintegration
 
}  // end of namespace petibm