genericc.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_GENERICC_H
#define MECHSYS_GENERICC_H

#include "models/coupled/coupledmodel.h"

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

template<class tEquilibModel, class tFlowModel>
class GenericC: public CoupledModel
{
public:
    // Constructor
    GenericC() : _equilib_model(NULL), _flow_model(NULL) {} 

    // Destructor
    ~GenericC();

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

    // Access methods
    Tensor2 const & Sig() const { return _equilib_model->Sig();   }
    Tensor2 const & Eps() const { return _equilib_model->Eps();   } 
    REAL            Pp () const { return    _flow_model->Pp();    } 
    REAL        GammaW () const { return    _flow_model->GammaW();} 
    int  nInternalStateValues ()                              const;
    void InternalStateValues  (Array<REAL>   & IntStateVals ) const;
    void InternalStateNames   (Array<String> & IntStateNames) const;

protected:
    // Protected methods
    void AllocateSubModels(Array<REAL> const & EquilibPrms    ,
                           Array<REAL> const & EquilibIniData ,
                           Array<REAL> const & FlowPrms       ,
                           Array<REAL> const & FlowIniData    );

private:
    // Data
    tEquilibModel * _equilib_model;
    tFlowModel    * _flow_model;

}; // class GenericC




template<class tEquilibModel, class tFlowModel>
inline GenericC<tEquilibModel,tFlowModel>::~GenericC() // {{{
{
    if (_equilib_model != NULL) delete _equilib_model;
    if (_flow_model    != NULL) delete _flow_model;
} // }}}

template<class tEquilibModel, class tFlowModel>
inline void GenericC<tEquilibModel,tFlowModel>::TgStiffness (Tensor4 & D, Tensor2 & d) const // {{{
{ 
    _equilib_model->TgStiffness(D);  
    d = 0.0*Tensors::I; // thereis no elasto-plastic part associated with suction in saturated cases
} // }}}

template<class tEquilibModel, class tFlowModel>
inline void GenericC<tEquilibModel,tFlowModel>::TgPermeability(Tensor2 & K) const // {{{
{
   _flow_model->TgPermeability(K);
} // }}}

template<class tEquilibModel, class tFlowModel>
inline void GenericC<tEquilibModel,tFlowModel>::FlowVelocity(Tensor1 const & Grad, Tensor1 & Vel) const // {{{
{
   _flow_model->FlowVelocity(Grad, Vel);
} // }}}

template<class tEquilibModel, class tFlowModel>
inline void GenericC<tEquilibModel,tFlowModel>::StressUpdate(Tensor2 const & DEps, REAL const & DPp, Tensor2 & DSig, REAL & DnSr) // {{{
{
    _equilib_model->StressUpdate(DEps, DSig);
    DnSr = -(DEps(0)+DEps(1)+DEps(2))*1.0;   // for saturated cases (Sr=1.0): DnSr = -dEv
} // }}}

template<class tEquilibModel, class tFlowModel>
inline void GenericC<tEquilibModel,tFlowModel>::FlowUpdate(REAL const & DPp) // {{{
{
    _flow_model->FlowUpdate(DPp);
} // }}}

template<class tEquilibModel, class tFlowModel>
inline void GenericC<tEquilibModel,tFlowModel>::BackupState() // {{{
{
    _equilib_model->BackupState();
       _flow_model->BackupState();
} // }}}

template<class tEquilibModel, class tFlowModel>
inline void GenericC<tEquilibModel,tFlowModel>::RestoreState() // {{{
{
    _equilib_model->RestoreState();
       _flow_model->RestoreState();
} // }}}

template<class tEquilibModel, class tFlowModel>
inline int GenericC<tEquilibModel,tFlowModel>::nInternalStateValues() const // {{{
{
    return _equilib_model->nInternalStateValues() + _flow_model->nInternalStateValues();
} // }}}

template<class tEquilibModel, class tFlowModel>
inline void GenericC<tEquilibModel,tFlowModel>::InternalStateValues(Array<REAL> & IntStateVals ) const // {{{
{
    Array<REAL> FlowIntStateVals;                          // Internal state values for flow model
    _equilib_model->InternalStateValues(IntStateVals);     // Get the internal state values for equilibrium model
       _flow_model->InternalStateValues(FlowIntStateVals); // Get the internal state values for flow model
    for (size_t i=0; i<FlowIntStateVals.size(); i++)
        IntStateVals.push_back(FlowIntStateVals[i]);       // Join the state values in one array
} // }}}

template<class tEquilibModel, class tFlowModel>
inline void GenericC<tEquilibModel,tFlowModel>::InternalStateNames (Array<String> & IntStateNames) const // {{{
{
    _equilib_model->InternalStateNames(IntStateNames);
} // }}}

template<class tEquilibModel, class tFlowModel>
inline void GenericC<tEquilibModel,tFlowModel>::AllocateSubModels(Array<REAL> const & EquilibPrms, // {{{
                                                                  Array<REAL> const & EquilibIniData,
                                                                  Array<REAL> const & FlowPrms,
                                                                  Array<REAL> const & FlowIniData) 
{
    _equilib_model = new tEquilibModel(EquilibPrms, EquilibIniData);
    _flow_model    = new tFlowModel   (FlowPrms,    FlowIniData);
} // }}}

#endif // MECHSYS_GENERICC_H

// vim:fdm=marker

---