linearflow.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_LINEARFLOWMODEL_H
#define MECHSYS_LINEARFLOWMODEL_H

#include "models/flow/flowmodel.h"

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

class LinearFlow: public FlowModel
{
public:
    // Constructor
    LinearFlow(Array<REAL> const & Prms, Array<REAL> const & IniData);

    // Destructor
    virtual ~LinearFlow() {}

    // Constatns
    static const size_t NPRMS = 2;
    static const size_t NIDAT = 1;

    // Derived methods
    String Name() const { return "LinearFlow"; };
    void   TgPermeability       (Tensor2 & K) const;
    void   FlowVelocity         (Tensor1 const & Grad, Tensor1 & Vel) const;
    void   FlowUpdate           (REAL const & DPp);
    void   BackupState          ();
    void   RestoreState         ();
    int    nInternalStateValues () const { return 0; };
    void   InternalStateValues  (Array<REAL>   & IntStateVals ) const {}
    void   InternalStateNames   (Array<String> & IntStateNames) const {}
    REAL   Pp                   () const { return _ppr; }; 
    REAL   GammaW               () const { return _gammaW; }

protected:
    // Data
    REAL _k;       // isotropic coeficient of permeability
    REAL _gammaW;   // Water specific weight
    REAL _ppr;     // pore-pressure
    REAL _ppr_bkp; // pore-pressure (backup)

}; // class LinFlow




inline LinearFlow::LinearFlow(Array<REAL> const & Prms, Array<REAL> const & IniData) // {{{
{
    
    // ##################################################################### Setup Parameters

    /* example.mat
     * #-----------------------
     * #             0        1
     * #             k      gammaW
     * LinearFlow  1.0e-4    10
     */

    // Check number of parameters
    if (Prms.size()!=NPRMS)
        throw new Fatal(_("LinearFlow::Constructor: The number of parameters is incorrect (it must be %d)"),NPRMS);

    // Parameters
    _k      = Prms[0];
    _gammaW = Prms[1];

    // Check number of initial data
    if (IniData.size()!=NIDAT)
        throw new Fatal(_("LinearFlow::Constructor: The number of initial (%d) data is incorrect { Pp }"),NIDAT);

    // Initial data
    _ppr = IniData[0];

} // }}}

inline void LinearFlow::TgPermeability(Tensor2 & K) const // {{{
{
    // Linear tangent permeability
    K = _k, _k, _k, 0,0,0;
} // }}}

inline void LinearFlow::FlowVelocity(Tensor1 const & Grad, Tensor1 & Vel) const // {{{
{
    Tensor2 K;
    TgPermeability(K); 
    Tensors::Dot(-K,Grad, Vel);
} // }}}

inline void LinearFlow::FlowUpdate(REAL const & DPp) // {{{
{
    // Update pore-pressure
    _ppr += DPp;
} // }}}

inline void LinearFlow::BackupState() // {{{
{
    _ppr_bkp = _ppr;
} // }}}

inline void LinearFlow::RestoreState() // {{{
{ 
    _ppr = _ppr_bkp;
} // }}}



// Allocate a new LinFlow model
FlowModel * LinearFlowMaker(Array<REAL> const & Prms, Array<REAL> const & IniData)
{
    return new LinearFlow(Prms, IniData);
}

// Register an LinearFlow model into ModelFactory array map
int LinearFlowRegister()
{
    FlowModelFactory["LinearFlow"] = LinearFlowMaker;
    return 0;
}

// Execute the autoregistration
int __LinearFlow_dummy_int = LinearFlowRegister();

// }}}

#endif // MECHSYS_LINEARFLOWMODEL_H

// vim:fdm=marker

---