Communicator.h

// -*-c++-*-
//----------------------------------------------------------------------------
//  XC program; finite element analysis code
//  for structural analysis and design.
//
//  Copyright (C)  Luis C. Pérez Tato
//
//  This program derives from OpenSees <http://opensees.berkeley.edu>
//  developed by the  «Pacific earthquake engineering research center».
//
//  Except for the restrictions that may arise from the copyright
//  of the original program (see copyright_opensees.txt)
//  XC 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 3 of the License, or 
//  (at your option) any later version.
//
//  This software 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 this program.
// If not, see <http://www.gnu.org/licenses/>.
//----------------------------------------------------------------------------
                                                                        
                                                                        
#ifndef Communicator_h
#define Communicator_h

#include "utility/matrix/ID.h"
#include <string>
#include "utility/actor/objectBroker/FEM_ObjectBroker.h"
#include "BrokedPtrCommMetaData.h"
#include <set>
#include "DbTagData.h"

namespace XC {
class Channel;
//class FEM_ObjectBroker;
class MovableID;
class Matrix;
class Vector;
class BJtensor;
class MovableVector;
class MovableMatrix;
class MovableString;
class MovableObject;
class ArrayCommMetaData;
class MatrixCommMetaData;
class TensorCommMetaData;
class Material;
class TimeSeries;
class ResponseId;
class DomainDecompositionAnalysis;
class CrdTransf;
class CrdTransf2d;
class CrdTransf3d;
class BeamIntegration;

//
class Communicator
  {
  private:
    int commitTag;
    Channel *canal;
    FEM_ObjectBroker *broker;
  public:
    Communicator(int cTag, Channel &);
    Communicator(int cTag, Channel &, FEM_ObjectBroker &);

    inline const int &getCommitTag(void) const
      { return commitTag; }
    int getDbTag(void) const;
    bool isDatastore(void) const;
    inline const Channel *getChannel(void) const
      { return canal; }
    inline Channel *getChannel(void)
      { return canal; }

    int sendIdData(const DbTagData &,const int &);
    int receiveIdData(DbTagData &,const int &) const;
    int sendID(const ID &,const int &);
    int receiveID(ID &v,const int &) const;
    int sendVector(const Vector &,const int &);
    int receiveVector(Vector &v,const int &) const;
    int sendMatrix(const Matrix &,const int &);
    int receiveMatrix(Matrix &v,const int &) const;

    int sendID(const ID &,DbTagData &, const CommMetaData &);
    int receiveID(ID &v,DbTagData &, const CommMetaData &) const;
    int sendIDPtr(ID *,DbTagData &, const ArrayCommMetaData &);
    ID *receiveIDPtr(ID* &,DbTagData &, const ArrayCommMetaData &) const;
    int sendMovableIDPtr(MovableID *,DbTagData &, const PtrCommMetaData &);
    MovableID *receiveMovableIDPtr(MovableID* &,DbTagData &, const PtrCommMetaData &);
    int sendMatrix(const Matrix &,DbTagData &, const CommMetaData &);
    int receiveMatrix(Matrix &v,DbTagData &, const CommMetaData &) const;
    int sendMatrixPtr(Matrix *ptr,DbTagData &, const MatrixCommMetaData &);
    Matrix *receiveMatrixPtr(Matrix* &ptr,DbTagData &, const MatrixCommMetaData &) const;
    int sendTensorPtr(BJtensor *ptr,DbTagData &, const TensorCommMetaData &);
    BJtensor *receiveTensorPtr(BJtensor* &ptr,DbTagData &, const TensorCommMetaData &) const;
    int sendMovableMatrixPtr(MovableMatrix *,DbTagData &, const PtrCommMetaData &);
    MovableMatrix *receiveMovableMatrixPtr(MovableMatrix* &,DbTagData &, const PtrCommMetaData &);

    int sendMatrices(const std::vector<Matrix> &,DbTagData &, const CommMetaData &);
    int receiveMatrices(std::vector<Matrix> &,DbTagData &, const CommMetaData &) const;

    int sendString(const std::string &,DbTagData &, const CommMetaData &);
    int receiveString(std::string &v,DbTagData &, const CommMetaData &) const;
    int sendStrings(std::deque<std::string> &,DbTagData &, const CommMetaData &);
    int receiveStrings(std::deque<std::string> &,DbTagData &, const CommMetaData &) const;
    int sendStrings(std::vector<std::string> &,DbTagData &, const CommMetaData &);
    int receiveStrings(std::vector<std::string> &,DbTagData &, const CommMetaData &) const;

    int sendVector(const Vector &,DbTagData &, const CommMetaData &);
    int receiveVector(Vector &v,DbTagData &, const CommMetaData &) const;
    int sendVectors(std::vector<Vector> &,DbTagData &, const CommMetaData &);
    int receiveVectors(std::vector<Vector> &v,DbTagData &, const CommMetaData &) const;
    int sendIDs(std::vector<ID> &,DbTagData &, const CommMetaData &);
    int receiveIDs(std::vector<ID> &v,DbTagData &, const CommMetaData &) const;
    int sendVector(const std::vector<double> &,DbTagData &, const CommMetaData &);
    int receiveVector(std::vector<double> &v,DbTagData &, const CommMetaData &) const;
    int sendVectorPtr(Vector *ptr,DbTagData &, const ArrayCommMetaData &);
    Vector *receiveVectorPtr(Vector* &ptr,DbTagData &, const ArrayCommMetaData &) const;
    int sendMovableVectorPtr(MovableVector *,DbTagData &, const PtrCommMetaData &);
    MovableVector *receiveMovableVectorPtr(MovableVector* &,DbTagData &, const PtrCommMetaData &);
    int sendTensor(const BJtensor &,DbTagData &, const CommMetaData &);
    int receiveTensor(BJtensor &v,DbTagData &, const CommMetaData &) const;

    int sendDoublePtr(double *,DbTagData &, const ArrayCommMetaData &);
    double *receiveDoublePtr(double* &,DbTagData &, const ArrayCommMetaData &) const;
    int sendDouble(const double &,DbTagData &, const CommMetaData &);
    int sendDoubles(const double &,const double &,DbTagData &, const CommMetaData &);
    int sendDoubles(const double &,const double &,const double &,DbTagData &, const CommMetaData &);
    int sendDoubles(const double &,const double &,const double &,const double &,DbTagData &, const CommMetaData &);
    int sendDoubles(const double &,const double &,const double &,const double &,const double &,DbTagData &, const CommMetaData &);
    int sendDoubles(const double &,const double &,const double &,const double &,const double &,const double &,DbTagData &, const CommMetaData &);
    int receiveDouble(double &,DbTagData &, const CommMetaData &) const;
    int receiveDoubles(double &,double &,DbTagData &, const CommMetaData &) const;
    int receiveDoubles(double &,double &,double &,DbTagData &, const CommMetaData &) const;
    int receiveDoubles(double &,double &,double &,double &,DbTagData &, const CommMetaData &) const;
    int receiveDoubles(double &,double &,double &,double &,double &,DbTagData &, const CommMetaData &) const;
    int receiveDoubles(double &,double &,double &,double &,double &,double &,DbTagData &, const CommMetaData &) const;

    int sendBool(const bool &,DbTagData &, const CommMetaData &);
    int sendBools(const bool &,const bool &,DbTagData &, const CommMetaData &);
    int sendBools(const bool &,const bool &,const bool &,DbTagData &, const CommMetaData &);
    int sendBools(const bool &,const bool &,const bool &,const bool &,DbTagData &, const CommMetaData &);
    int sendBools(const bool &,const bool &,const bool &,const bool &,const bool &,DbTagData &, const CommMetaData &);
    int sendBools(const bool &,const bool &,const bool &,const bool &,const bool &,const bool &,DbTagData &, const CommMetaData &);
    int receiveBool(bool &,DbTagData &, const CommMetaData &) const;
    int receiveBools(bool &,bool &,DbTagData &, const CommMetaData &) const;
    int receiveBools(bool &,bool &,bool &,DbTagData &, const CommMetaData &) const;
    int receiveBools(bool &,bool &,bool &,bool &,DbTagData &, const CommMetaData &) const;
    int receiveBools(bool &,bool &,bool &,bool &,bool &,DbTagData &, const CommMetaData &) const;
    int receiveBools(bool &,bool &,bool &,bool &,bool &,bool &,DbTagData &, const CommMetaData &) const;

    int sendInt(const int &,DbTagData &, const CommMetaData &);
    int sendInts(const int &,const int &,DbTagData &, const CommMetaData &);
    int sendInts(const int &,const int &,const int &,DbTagData &, const CommMetaData &);
    int sendInts(const int &,const int &,const int &,const int &,DbTagData &, const CommMetaData &);
    int sendInts(const int &,const int &,const int &,const int &,const int &,DbTagData &, const CommMetaData &);
    int sendInts(const int &,const int &,const int &,const int &,const int &,const int &,DbTagData &, const CommMetaData &);
    int receiveInt(int &,DbTagData &, const CommMetaData &) const;
    int receiveInts(int &,int &,DbTagData &, const CommMetaData &) const;
    int receiveInts(int &,int &,int &,DbTagData &, const CommMetaData &) const;
    int receiveInts(int &,int &,int &,int &,DbTagData &, const CommMetaData &) const;
    int receiveInts(int &,int &,int &,int &,int &,DbTagData &, const CommMetaData &) const;
    int receiveInts(int &,int &,int &,int &,int &,int &,DbTagData &, const CommMetaData &) const;

    size_t sendSzt(const size_t &,DbTagData &, const CommMetaData &);
    size_t sendSzts(const size_t &,const size_t &,DbTagData &, const CommMetaData &);
    size_t sendSzts(const size_t &,const size_t &,const size_t &,DbTagData &, const CommMetaData &);
    size_t sendSzts(const size_t &,const size_t &,const size_t &,const size_t &,DbTagData &, const CommMetaData &);
    size_t sendSzts(const size_t &,const size_t &,const size_t &,const size_t &,const size_t &,DbTagData &, const CommMetaData &);
    size_t sendSzts(const size_t &,const size_t &,const size_t &,const size_t &,const size_t &,const size_t &,DbTagData &, const CommMetaData &);
    size_t receiveSzt(size_t &,DbTagData &, const CommMetaData &) const;
    size_t receiveSzts(size_t &,size_t &,DbTagData &, const CommMetaData &) const;
    size_t receiveSzts(size_t &,size_t &,size_t &,DbTagData &, const CommMetaData &) const;
    size_t receiveSzts(size_t &,size_t &,size_t &,size_t &,DbTagData &, const CommMetaData &) const;
    size_t receiveSzts(size_t &,size_t &,size_t &,size_t &,size_t &,DbTagData &, const CommMetaData &) const;
    size_t receiveSzts(size_t &,size_t &,size_t &,size_t &,size_t &,size_t &,DbTagData &, const CommMetaData &) const;

    ResponseId *receiveResponseIdPtr(ResponseId* &,DbTagData &, const ArrayCommMetaData &) const;

    int sendMovable(MovableObject &,DbTagData &, const CommMetaData &);
    int receiveMovable(MovableObject &,DbTagData &, const CommMetaData &) const;
    int sendMovablePtr(MovableObject *ptr,DbTagData &, const PtrCommMetaData &);
    template <class MOV>
    MOV *receiveMovablePtr(MOV* &,DbTagData &, const PtrCommMetaData &) const;

    

    int sendBrokedPtr(MovableObject *ptr,DbTagData &, const BrokedPtrCommMetaData &);
    template <class T>
    T *getBrokedPtr(const int &,T *(FEM_ObjectBroker::*ptrFunc)(int)) const;
    template <class T>
    T *getBrokedTagged(T* &ptr,const int &,const int &,const int &,T *(FEM_ObjectBroker::*ptrFunc)(int)) const;

    template <class MAT>
    MAT *getBrokedMaterial(MAT* &,DbTagData &, const BrokedPtrCommMetaData &) const;
    template <class HDL>
    HDL *getBrokedDataOutputHandler(HDL* &,DbTagData &, const BrokedPtrCommMetaData &) const;
    template <class GM>
    GM *getBrokedGroundMotion(GM* &,DbTagData &, const BrokedPtrCommMetaData &) const;

    ConstraintHandler *brokeConstraintHandler(const int &) const;
    DOF_Numberer *brokeNumberer(const int &) const;
    AnalysisModel *brokeAnalysisModel(const int &) const;
    LinearSOE *brokeDDLinearSOE(const int &,const int &) const;
    LinearSOE *brokeLinearSOE(const int &,const int &) const;
    IncrementalIntegrator *brokeIncrementalIntegrator(const int &) const;
    StaticIntegrator *brokeStaticIntegrator(const int &) const;
    TransientIntegrator *brokeTransientIntegrator(const int &) const;
    DomainDecompAlgo *brokeDomainDecompAlgo(const int &) const;
    EquiSolnAlgo *brokeEquiSolnAlgo(const int &) const;
    GroundMotion *brokeGroundMotion(const int &) const;
    DomainSolver *getNewDomainSolver(void) const;
    DomainDecompositionAnalysis *getNewDomainDecompAnalysis(int, Subdomain &) const;
    ConvergenceTest *getNewConvergenceTest(CommandEntity *owr,int classTag) const;
    TimeSeries *getNewTimeSeries(int classTag) const;
    CrdTransf2d *getNewCrdTransf2d(int classTag) const;
    CrdTransf3d *getNewCrdTransf3d(int classTag) const;
    CrdTransf *getNewCrdTransf(int classTag) const;
    ShellCrdTransf3dBase *getNewShellCrdTransf3d(int classTag) const;
    BeamIntegration *getNewBeamIntegration(int classTag) const;
  };

template <class T>
T *Communicator::getBrokedPtr(const int &classTag,T *(FEM_ObjectBroker::*ptrFunc)(int)) const
  {
    assert(broker);
    T *retval=((*broker).*ptrFunc)(classTag);  
    return retval;
  }

template <class MAT>
MAT *Communicator::getBrokedMaterial(MAT* &ptr,DbTagData &dbTagData, const BrokedPtrCommMetaData &md) const
  {
    if(!ptr)
      {
        assert(broker);
        const int classTag= dbTagData.getDbTagDataPos(md.getPosClassTag());
        Material *tmp= broker->getNewMaterial(classTag);
        if(tmp)
          {
            ptr= dynamic_cast<MAT *>(tmp);
            if(ptr)
              {
                const int res= receiveMovable(*ptr,dbTagData,md);
                if(res<0)
                std::cerr <<"WARNING - receiveMaterialPtr "
                         << "failed to receive material.\n";
              }
            else
              {
                delete tmp;
                std::cerr << "Communicator::getBrokedMaterial "
                          << " wrong material class."
                          << std::endl;
              }
          }
        else
          std::cerr << "getBrokedMaterial: "
                    << " broker could not create material of class type: "
                    << classTag << std::endl;;
      }
    return ptr;
  }

template <class HDL>
HDL *Communicator::getBrokedDataOutputHandler(HDL* &ptr,DbTagData &dbTagData, const BrokedPtrCommMetaData &md) const
  {
    if(!ptr)
      {
        assert(broker);
        const int classTag= dbTagData.getDbTagDataPos(md.getPosClassTag());
        DataOutputHandler *tmp= broker->getPtrNewDataOutputHandler(classTag);
        if(tmp)
          {
            ptr= dynamic_cast<HDL *>(tmp);
            if(!ptr) delete tmp;
          }
        else
          std::cerr << "getBrokedDataOutputHandlerMaterial: "
                    << " broker could not create handler of class type: "
                    << classTag << std::endl;;
      }
    return ptr;
  }

template <class GM>
GM *Communicator::getBrokedGroundMotion(GM* &ptr,DbTagData &dbTagData, const BrokedPtrCommMetaData &md) const
  {
    if(!ptr)
      {
        assert(broker);
        const int classTag= dbTagData.getDbTagDataPos(md.getPosClassTag());
        GroundMotion *tmp= broker->getNewGroundMotion(classTag);
        if(tmp)
          {
            ptr= dynamic_cast<GM *>(tmp);
            if(!ptr) delete tmp;
          }
        else
          std::cerr << "getBrokedGroundMotion: "
                    << " broker could not create ground motion of class type: "
                    << classTag << std::endl;;
      }
    return ptr;
  }

template <class T>
T *Communicator::getBrokedTagged(T* &ptr,const int &dbTag,const int &objTag,const int &classTag,T *(FEM_ObjectBroker::*ptrFunc)(int)) const
  {
    if(!ptr)
      {
        assert(broker);
        T *retval=((*broker).*ptrFunc)(classTag);
  
        if(retval)
          {
            retval->setDbTag(dbTag);
            retval->setTag(objTag);
            ptr= retval;
          }
        else
          std::cerr << "getBrokedTagged; can't create object con classTag: " 
                    << classTag << std::endl;
      }
    return ptr;
  }

template <class MOV>
MOV *Communicator::receiveMovablePtr(MOV* &ptr,DbTagData &dbTagData, const PtrCommMetaData &meta) const
  {
    if(dbTagData.getDbTagDataPos(meta.getPosFlag()) == 0)
      {
        // make some room and read in the ID
        if(!ptr)
          {
            ptr= new MOV();
            if(!ptr)
              std::cerr << "receiveMovableIDPtr -- ran out of memory\n";
          }
        if(ptr)
          {
            ptr->setDbTag(dbTagData.getDbTagDataPos(meta.getPosDbTag()));
            int res= ptr->recvSelf(*this);
            if(res < 0)
              std::cerr << "receiveMovableIDPtr - failed to receive ID data\n";
          }
      }
    return ptr;
  }

} // end of XC namespace

#endif