table.h

// This file is part of HermesCommon
//
// Copyright (c) 2009 hp-FEM group at the University of Nevada, Reno (UNR).
// Email: hpfem-group@unr.edu, home page: http://www.hpfem.org/.
//
// Hermes2D is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published
// by the Free Software Foundation; either version 2 of the License,
// or (at your option) any later version.
//
// Hermes2D is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Hermes2D; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#ifndef __HERMES_COMMON_TABLES_H_
#define __HERMES_COMMON_TABLES_H_

#include "util/compat.h"

namespace Hermes
{
  enum ButcherTableType
  {
    /* EXPLICIT METHODS */

    Explicit_RK_1,               
    Explicit_RK_2,               
    Explicit_RK_3,               
    Explicit_RK_4,               

    /* IMPLICIT METHODS */

    Implicit_RK_1,               
    Implicit_Crank_Nicolson_2_2, 
    Implicit_SIRK_2_2,           
    Implicit_ESIRK_2_2,          
    Implicit_SDIRK_2_2,          
    Implicit_Lobatto_IIIA_2_2,   
    Implicit_Lobatto_IIIB_2_2,   
    Implicit_Lobatto_IIIC_2_2,   
    Implicit_Lobatto_IIIA_3_4,   
    Implicit_Lobatto_IIIB_3_4,   
    Implicit_Lobatto_IIIC_3_4,   
    Implicit_Radau_IIA_3_5,      
    Implicit_SDIRK_5_4,          

    /* EMBEDDED EXPLICIT METHODS */

    Explicit_HEUN_EULER_2_12_embedded,          
    Explicit_BOGACKI_SHAMPINE_4_23_embedded,    
    Explicit_FEHLBERG_6_45_embedded,            
    Explicit_CASH_KARP_6_45_embedded,           
    Explicit_DORMAND_PRINCE_7_45_embedded,      

    /* EMBEDDED IMPLICIT METHODS */

    Implicit_ESDIRK_TRBDF2_3_23_embedded,    
    Implicit_ESDIRK_TRX2_3_23_embedded,      
    Implicit_SDIRK_CASH_3_23_embedded,       
    Implicit_SDIRK_BILLINGTON_3_23_embedded, 
    Implicit_SDIRK_CASH_5_24_embedded,       
    Implicit_SDIRK_CASH_5_34_embedded,       
    Implicit_DIRK_ISMAIL_7_45_embedded       
  };

  class HERMES_API Table
  {
  public:
    Table();
    Table(unsigned int size);
    virtual void alloc(unsigned int size);
    unsigned int get_size();
    double get_A(unsigned int i, unsigned int j);
    void set_A(unsigned int i, unsigned int j, double val);

  protected:
    unsigned int size;
    double** A;
  };

  class HERMES_API ButcherTable : public Table
  {
  public:
    ButcherTable();
    ButcherTable(unsigned int size);
    ButcherTable(ButcherTableType butcher_table);
    ~ButcherTable();
    virtual void free();
    virtual void alloc(unsigned int size);
    double get_B(unsigned int i);
    double get_B2(unsigned int i);
    double get_C(unsigned int i);
    void set_B(unsigned int i, double val);
    void set_B2(unsigned int i, double val);
    void set_C(unsigned int i, double val);
    bool is_explicit();
    bool is_diagonally_implicit();
    bool is_fully_implicit();
    bool is_embedded();
    void switch_B_rows();

  protected:
    double* B;
    double* B2;
    double* C;
  };
}
#endif