Canoe
Comprehensive Atmosphere N' Ocean Engine
MultiStageIntegrator Class Referenceabstract

#include <integrators.hpp>

Inheritance diagram for MultiStageIntegrator:
[legend]

Public Member Functions

virtual ~MultiStageIntegrator ()
 
virtual void TimeIntegrate (Real time, Real dt)=0
 
virtual void WeightedAverage (Real ave_wghts[])=0
 
IntegratorWeight const & GetStageWeights (int stage) const
 
void SetIntegrator (std::string name)
 
int GetNumStages () const
 

Protected Attributes

IntegratorWeight stage_wghts_ [MAX_NSTAGE]
 
int nstages_
 

Detailed Description

Definition at line 20 of file integrators.hpp.

Constructor & Destructor Documentation

◆ ~MultiStageIntegrator()

virtual MultiStageIntegrator::~MultiStageIntegrator ( )
inlinevirtual

Definition at line 22 of file integrators.hpp.

Member Function Documentation

◆ TimeIntegrate()

virtual void MultiStageIntegrator::TimeIntegrate ( Real  time,
Real  dt 
)
pure virtual

Implemented in ParticleBase.

◆ WeightedAverage()

virtual void MultiStageIntegrator::WeightedAverage ( Real  ave_wghts[])
pure virtual

Implemented in ParticleBase.

◆ GetStageWeights()

IntegratorWeight const& MultiStageIntegrator::GetStageWeights ( int  stage) const
inline

Definition at line 26 of file integrators.hpp.

◆ SetIntegrator()

void MultiStageIntegrator::SetIntegrator ( std::string  name)
Note
integrator == "vl2"
  • VL: second-order van Leer integrator (Stone & Gardiner, NewA 14, 139 2009)
  • Simple predictor-corrector scheme similar to MUSCL-Hancock
  • Expressed in 2S or 3S* algorithm form
integrator == "rk3"
  • SSPRK (3,3): Gottlieb (2009) equation 3.2
  • Optimal (in error bounds) explicit three-stage, third-order SSPRK

Definition at line 4 of file integrators.cpp.

◆ GetNumStages()

int MultiStageIntegrator::GetNumStages ( ) const
inline

Definition at line 31 of file integrators.hpp.

Member Data Documentation

◆ stage_wghts_

IntegratorWeight MultiStageIntegrator::stage_wghts_[MAX_NSTAGE]
protected

Definition at line 34 of file integrators.hpp.

◆ nstages_

int MultiStageIntegrator::nstages_
protected

Definition at line 35 of file integrators.hpp.


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