flowmodel.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_FLOWMODEL_H
#define MECHSYS_FLOWMODEL_H

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

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

// Blitz++
#include <blitz/tinyvec-et.h>

// MechSys
#include "util/array.h"
#include "tensors/tensors.h"

using Tensors::Tensor2;

class FlowModel
{
public:
    // Destructor
    virtual ~FlowModel() {}

    // Methods
    virtual String Name           () const =0;
    virtual void   TgPermeability (Tensor2 & K) const =0;
    virtual void   FlowVelocity   (Tensor1 const & Grad, Tensor1 & Vel) const =0;
    virtual void   FlowUpdate     (REAL const & DPp) =0;
    virtual void   BackupState    () =0;
    virtual void   RestoreState   () =0;

    // Access methods
    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;

}; // class FlowModel



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

// Typdef of the array map that contains all the pointers to the functions that makes FlowModels
typedef std::map<String, FlowModelMakerPtr, std::less<String> > FlowModelFactory_t;

// Instantiate the array map that contains all the pointers to the functions that makes FlowModels
FlowModelFactory_t FlowModelFactory;

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

// }}}

#endif // MECHSYS_FLOWMODEL_H

// vim:fdm=marker

---