implicit.hh

Go to the documentation of this file.

#ifndef DUNE_FEM_SOLVER_RUNGEKUTTA_IMPLICIT_HH
#define DUNE_FEM_SOLVER_RUNGEKUTTA_IMPLICIT_HH
 
//- system includes
#include <sstream>
#include <vector>
 
//- dune-common includes
#include <dune/common/exceptions.hh>
 
//- dune-fem includes
#include <dune/fem/solver/rungekutta/basicimplicit.hh>
#include <dune/fem/solver/rungekutta/butchertable.hh>
#include <dune/fem/solver/rungekutta/timestepcontrol.hh>
 
namespace DuneODE
{
 
  // ImplicitRungeKuttaSolver
  // ------------------------
 
  template< class HelmholtzOperator, class NonlinearSolver, class TimeStepControl = ImplicitRungeKuttaTimeStepControl >
  class ImplicitRungeKuttaSolver
  : public BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >
  {
    typedef ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl > ThisType;
    typedef BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl > BaseType;
 
  public:
    typedef HelmholtzOperator HelmholtzOperatorType;
    typedef typename BaseType::TimeStepControlType TimeStepControlType;
 
    typedef typename TimeStepControlType::TimeProviderType   TimeProviderType;
    typedef typename BaseType::ParameterType                ParameterType;
    typedef typename BaseType::NonlinearSolverParameterType NonlinearSolverParameterType;
 
    ImplicitRungeKuttaSolver ( HelmholtzOperatorType &helmholtzOp,
                               TimeProviderType &timeProvider,
                               const SimpleButcherTable< double >& butcherTable,
                               const Dune::Fem::ParameterReader &parameter = Dune::Fem::Parameter::container() )
    : BaseType( helmholtzOp,
                butcherTable,
                TimeStepControlType( timeProvider, ParameterType( parameter ) ),
                NonlinearSolverParameterType( parameter )
              )
    {}
 
    ImplicitRungeKuttaSolver ( HelmholtzOperatorType &helmholtzOp,
                               TimeProviderType &timeProvider,
                               int order,
                               const ParameterType& tscParam,
                               const NonlinearSolverParameterType& nlsParam )
    : BaseType( helmholtzOp,
                defaultButcherTables( tscParam.selectedSolver( order ) ),
                TimeStepControlType( timeProvider, tscParam ),
                nlsParam )
    {}
 
    ImplicitRungeKuttaSolver ( HelmholtzOperatorType &helmholtzOp,
                               TimeProviderType &timeProvider,
                               int order,
                               const Dune::Fem::ParameterReader &parameter = Dune::Fem::Parameter::container() )
    : BaseType( helmholtzOp,
                defaultButcherTables( ParameterType( parameter ).selectedSolver( order ) ),
                TimeStepControlType( timeProvider, ParameterType( parameter ) ),
                NonlinearSolverParameterType( parameter ) )
    {}
 
    ImplicitRungeKuttaSolver ( HelmholtzOperatorType &helmholtzOp,
                               TimeProviderType &timeProvider,
                               const ParameterType& tscParam,
                               const NonlinearSolverParameterType& nlsParam )
    : BaseType( helmholtzOp,
                defaultButcherTables( tscParam.selectedSolver( 1 ) ),
                TimeStepControlType( timeProvider, tscParam ),
                nlsParam )
    {}
 
    ImplicitRungeKuttaSolver ( HelmholtzOperatorType &helmholtzOp,
                               TimeProviderType &timeProvider,
                               const Dune::Fem::ParameterReader &parameter = Dune::Fem::Parameter::container() )
    : BaseType( helmholtzOp,
                defaultButcherTables( ParameterType( parameter ).selectedSolver( 1 ) ),
                TimeStepControlType( timeProvider, ParameterType( parameter ) ),
                NonlinearSolverParameterType( parameter ) )
    {}
 
  protected:
    static SimpleButcherTable< double > defaultButcherTables ( const int solverId )
    {
      switch( solverId )
      {
      case 1:
        return implicitEulerButcherTable();
      case 2:
        return gauss2ButcherTable();
      case 3:
        return implicit3ButcherTable();
      case 4:
        return implicit34ButcherTable();
      default:
        DUNE_THROW( NotImplemented, "Implicit Runge-Kutta method with id " << solverId << " not implemented." );
      }
    }
  };
 
} // namespace DuneODE
 
#endif // #ifndef DUNE_FEM_SOLVER_RUNGEKUTTA_IMPLICIT_HH