integschemesctes.h

/*************************************************************************************
 * MechSys - A C++ library to simulate (Continuum) Mechanical Systems                *
 * Copyright (C) 2005 Dorival de Moraes Pedroso <dorival.pedroso at gmail.com>       *
 * Copyright (C) 2005 Raul Dario Durand Farfan  <raul.durand at gmail.com>           *
 *                                                                                   *
 * This file is part of MechSys.                                                     *
 *                                                                                   *
 * MechSys 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.                                                                          *
 *                                                                                   *
 * MechSys 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      *
 * MechSys; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, *
 * Fifth Floor, Boston, MA 02110-1301, USA                                           *
 *************************************************************************************/

#ifndef MECHSYS_INTEGSCHEMESCTES_H
#define MECHSYS_INTEGSCHEMESCTES_H

#ifdef HAVE_CONFIG_H
  #include "config.h"
#else
  #ifndef REAL
    #define REAL double
  #endif
#endif

#include "util/string.h"
#include "util/exception.h"

class IntegSchemesCtes
{
public:
    enum ISCType {FE,  // FE : Forward-Euler
                  ME}; // ME : (Automatic) Modified Euler
    
    // Constructor
    IntegSchemesCtes()
        : _type     (ME    ),
          _FE_ndiv  (1000  ),
          _ME_maxSS (200   ),
          _ME_STOL  (1.0e-3),
          _ME_dTini (0.001 ),
          _ME_mMin  (0.01  ),
          _ME_mMax  (10.0  ),
          _Ed_max   (0.5   )
    {}

    // Setup methods
    IntegSchemesCtes & Type    (String const & Type );
    IntegSchemesCtes & Type    (ISCType        Type ) { _type     = Type;  return (*this); }
    IntegSchemesCtes & FE_ndiv (int            ndiv ) { _FE_ndiv  = ndiv;  return (*this); }
    IntegSchemesCtes & ME_maxSS(int            maxSS) { _ME_maxSS = maxSS; return (*this); }
    IntegSchemesCtes & ME_STOL (REAL           STOL ) { _ME_STOL  = STOL;  return (*this); }
    IntegSchemesCtes & ME_dTini(REAL           dTini) { _ME_dTini = dTini; return (*this); }
    IntegSchemesCtes & ME_mMin (REAL           mMin ) { _ME_mMin  = mMin;  return (*this); }
    IntegSchemesCtes & ME_mMax (REAL           mMax ) { _ME_mMax  = mMax;  return (*this); }
    IntegSchemesCtes & EdMax   (REAL           EdMax) { _Ed_max   = EdMax; return (*this); }

    // Access methods
    ISCType        const & Type    () const { return _type;     }
    int            const & FE_ndiv () const { return _FE_ndiv;  }
    int            const & ME_maxSS() const { return _ME_maxSS; }
    REAL           const & ME_STOL () const { return _ME_STOL;  }
    REAL           const & ME_dTini() const { return _ME_dTini; }
    REAL           const & ME_mMin () const { return _ME_mMin;  }
    REAL           const & ME_mMax () const { return _ME_mMax;  }
    REAL           const & EdMax   () const { return _Ed_max;   }

private:
    // Data
    ISCType        _type;     
    int            _FE_ndiv;  
    int            _ME_maxSS; 
    REAL           _ME_STOL;  
    REAL           _ME_dTini; 
    REAL           _ME_mMin;  
    REAL           _ME_mMax;  
    REAL           _Ed_max;   

}; // class IntegSchemesCtes




inline IntegSchemesCtes & IntegSchemesCtes::Type(String const & Type) // {{{
{
         if (Type=="FE") _type=FE;
    else if (Type=="ME") _type=ME;
    else throw new Fatal(_("IntegSchemesCtes::Type: <%s> is an invalid type"), Type.c_str());
    return (*this); 
} // }}}

#endif // MECHSYS_INTEGSCHEMESCTES_H

// vim:fdm=marker

---