coupledmodel.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_COUPLEDMODEL_H
#define MECHSYS_COUPLEDMODEL_H

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

// STL
#include <map>
#include <string>

// MechSys
#include "tensors/tensors.h"
#include "util/string.h"
#include "util/array.h"
#include "numerical/integschemesctes.h"

using Tensors::Tensor1;
using Tensors::Tensor2;
using Tensors::Tensor4;

class CoupledModel
{
public:

    // Destructor
    virtual ~CoupledModel(){};

    // Methods
    virtual String Name            () const =0;
    virtual void   TgStiffness     (Tensor4 & D, Tensor2 & d) const =0; 
    virtual REAL   Sr              () const =0; // Degree of saturation
    virtual REAL   phi             () const =0; // Sig_net = Sig_tot - phi*Suc*I
    virtual REAL   n_times_dSr_dPp () const =0; // n:porosity times dSr_dPp (derivative of degree of sat. w.r.t. porepressure)
    virtual void   TgPermeability  (Tensor2 & k) const =0; 
    virtual void   FlowVelocity    (Tensor1 const & Grad, Tensor1 & Vel) const =0;
    virtual void   Actualize       (Tensor2 const & DSig, REAL const & DPp, Tensor2 & DEps, REAL & DnSr) =0;
    virtual void   StressUpdate    (Tensor2 const & DEps, REAL const & DPp, Tensor2 & DSig, REAL & DnSr) =0;
    virtual void   FlowUpdate      (REAL const & DPp) =0;
    virtual void   BackupState     () =0;
    virtual void   RestoreState    () =0;

    // Access methods
    virtual Tensor2 const & Sig() const =0;
    virtual Tensor2 const & Eps() const =0; 
    virtual REAL            Pp () const =0; 
    virtual REAL         GammaW() const =0;
    virtual int  nInternalStateValues()                              const =0;
    virtual void InternalStateValues (Array<REAL>   & IntStateVals ) const =0;
    virtual void InternalStateNames  (Array<String> & IntStateNames) const =0;

    // Static
    static void SetIntegSchemesCtes(IntegSchemesCtes const & ISC) { _isc=ISC; }

protected:
    // Data (static)
    static IntegSchemesCtes _isc; 

}; // class CoupledModel




IntegSchemesCtes CoupledModel::_isc;



// Define a pointer to a function that makes (allocate) a new equilibmodel
typedef CoupledModel * (*CoupledModelMakerPtr)(Array<REAL> const & Prms, Array<REAL> const & IniData);

// Typdef of the array map that contains all the pointers to the functions that makes equilibmodels
typedef std::map<String, CoupledModelMakerPtr, std::less<String> > CoupledModelFactory_t;

// Instantiate the array map that contains all the pointers to the functions that makes equilibmodels
CoupledModelFactory_t CoupledModelFactory;

// Allocate a new coupledmodel according to a string giving the name of the coupledmodel
CoupledModel * AllocCoupledModel(String const & Name, Array<REAL> const & Prms, Array<REAL> const & IniData)
{
    CoupledModelMakerPtr ptr=NULL;
    ptr = CoupledModelFactory[Name];
    if (ptr==NULL)
        throw new Fatal(_("FEM::AllocCoupledModel: There is no < %s >  implemented in this library\n"),Name.c_str());
    return (*ptr)(Prms, IniData);
}

// }}}

#endif // MECHSYS_COUPLEDMODEL_H

// vim:fdm=marker

---