/[escript]/trunk/finley/src/CPPAdapter/MeshAdapter.h
ViewVC logotype

Diff of /trunk/finley/src/CPPAdapter/MeshAdapter.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1326 by ksteube, Mon Oct 1 08:10:41 2007 UTC revision 2640 by jfenwick, Mon Aug 31 06:22:10 2009 UTC
# Line 1  Line 1 
1    
 /* $Id$ */  
   
2  /*******************************************************  /*******************************************************
3   *  *
4   *           Copyright 2003-2007 by ACceSS MNRF  * Copyright (c) 2003-2009 by University of Queensland
5   *       Copyright 2007 by University of Queensland  * Earth Systems Science Computational Center (ESSCC)
6   *  * http://www.uq.edu.au/esscc
7   *                http://esscc.uq.edu.au  *
8   *        Primary Business: Queensland, Australia  * Primary Business: Queensland, Australia
9   *  Licensed under the Open Software License version 3.0  * Licensed under the Open Software License version 3.0
10   *     http://www.opensource.org/licenses/osl-3.0.php  * http://www.opensource.org/licenses/osl-3.0.php
11   *  *
12   *******************************************************/  *******************************************************/
13    
14    
15  #if !defined finley_MeshAdapter_20040526_H  #if !defined finley_MeshAdapter_20040526_H
16  #define finley_MeshAdapter_20040526_H  #define finley_MeshAdapter_20040526_H
# Line 22  extern "C" { Line 21  extern "C" {
21  #include "../Finley.h"  #include "../Finley.h"
22  #include "../Assemble.h"  #include "../Assemble.h"
23  #include "paso/SystemMatrix.h"  #include "paso/SystemMatrix.h"
24    #include "paso/SolverFCT.h"
25    #include "paso/Paso_MPI.h"
26  }  }
27    
28  #include "FinleyError.h"  #include "FinleyError.h"
29  #include "FinleyAdapterException.h"  #include "FinleyAdapterException.h"
30    
31  #include "SystemMatrixAdapter.h"  #include "SystemMatrixAdapter.h"
32    #include "TransportProblemAdapter.h"
33  #include "escript/AbstractContinuousDomain.h"  #include "escript/AbstractContinuousDomain.h"
34  #include "escript/FunctionSpace.h"  #include "escript/FunctionSpace.h"
35  #include "escript/FunctionSpaceFactory.h"  #include "escript/FunctionSpaceFactory.h"
# Line 140  class MeshAdapter : public escript::Abst Line 142  class MeshAdapter : public escript::Abst
142    
143    /**    /**
144       \brief       \brief
145         If compiled for MPI then execute an MPI_Barrier, else do nothing
146      */
147    
148      FINLEY_DLL_API
149      virtual void MPIBarrier() const;
150    
151      /**
152         \brief
153         Return true if on MPI processor 0, else false
154      */
155    
156      FINLEY_DLL_API
157      virtual bool onMasterProcessor() const;
158    
159      FINLEY_DLL_API
160    #ifdef PASO_MPI
161      MPI_Comm
162    #else
163      unsigned int
164    #endif
165      getMPIComm() const;
166    
167      /**
168         \brief
169       return this as an AbstractContinuousDomain.       return this as an AbstractContinuousDomain.
170    */    */
171    inline const AbstractContinuousDomain& asAbstractContinuousDomain() const    inline const AbstractContinuousDomain& asAbstractContinuousDomain() const
# Line 166  class MeshAdapter : public escript::Abst Line 192  class MeshAdapter : public escript::Abst
192    
193    /**    /**
194       \brief       \brief
195       Write the current mesh to a file with the given name.       \param full
      \param fileName Input - The name of the file to write to.  
196    */    */
197    FINLEY_DLL_API    FINLEY_DLL_API
198    void Print_Mesh_Info() const;    void Print_Mesh_Info(const bool full=false) const;
199    
200    /**    /**
201       \brief       \brief
# Line 202  class MeshAdapter : public escript::Abst Line 227  class MeshAdapter : public escript::Abst
227       \param functionSpaceType Input - The function space type.       \param functionSpaceType Input - The function space type.
228    */    */
229    FINLEY_DLL_API    FINLEY_DLL_API
230    int* borrowSampleReferenceIDs(int functionSpaceType) const;    const int* borrowSampleReferenceIDs(int functionSpaceType) const;
231    
232    /**    /**
233       \brief       \brief
# Line 338  class MeshAdapter : public escript::Abst Line 363  class MeshAdapter : public escript::Abst
363    
364    /**    /**
365       \brief       \brief
366          Returns a status indicator of the domain. The status identifier should be unique over
367          the live time if the object but may be updated if changes to the domain happen, e.g.
368          modifications to its geometry.
369    
370         This has to be implemented by the actual Domain adapter.
371      */
372      FINLEY_DLL_API
373      virtual StatusType getStatus() const;
374    
375    
376      /**
377         \brief
378         Return the number of data points summed across all MPI processes
379      */
380      FINLEY_DLL_API
381      virtual int getNumDataPointsGlobal() const;
382    
383      /**
384         \brief
385       Return the number of data points per sample, and the number of samples as a pair.       Return the number of data points per sample, and the number of samples as a pair.
386       \param functionSpaceCode Input -       \param functionSpaceCode Input -
387    */    */
# Line 397  class MeshAdapter : public escript::Abst Line 441  class MeshAdapter : public escript::Abst
441    */    */
442    FINLEY_DLL_API    FINLEY_DLL_API
443    virtual void interpolateOnDomain(escript::Data& target,const escript::Data& source) const;    virtual void interpolateOnDomain(escript::Data& target,const escript::Data& source) const;
444    
445    
446    FINLEY_DLL_API    FINLEY_DLL_API
447    virtual bool probeInterpolationOnDomain(int functionSpaceType_source,int functionSpaceType_target) const;    virtual bool probeInterpolationOnDomain(int functionSpaceType_source,int functionSpaceType_target) const;
448    
449    /**    /**
450        \brief given a vector of FunctionSpace typecodes, pass back a code which then can all be interpolated to.
451        \return true is result is valid, false if not
452      */
453      FINLEY_DLL_API
454      bool
455      commonFunctionSpace(const std::vector<int>& fs, int& resultcode) const;
456    
457      /**
458       \brief       \brief
459       interpolates data given on source onto target where source and target are given on different domains.       interpolates data given on source onto target where source and target are given on different domains.
460       has to be implemented by the actual Domain adapter.       has to be implemented by the actual Domain adapter.
461    */    */
462    FINLEY_DLL_API    FINLEY_DLL_API
463    virtual void interpolateACross(escript::Data& target, const escript::Data& source) const;    virtual void interpolateACross(escript::Data& target, const escript::Data& source) const;
464    
465      /**
466      \brief determines whether interpolation from source to target is possible.
467      Must be implemented by the actual Domain adapter
468      */
469    FINLEY_DLL_API    FINLEY_DLL_API
470    virtual bool probeInterpolationACross(int functionSpaceType_source,const AbstractDomain& targetDomain, int functionSpaceType_target) const;    virtual bool probeInterpolationACross(int functionSpaceType_source,const escript::AbstractDomain& targetDomain, int functionSpaceType_target) const;
471    
472    /**    /**
473       \brief       \brief
# Line 444  class MeshAdapter : public escript::Abst Line 503  class MeshAdapter : public escript::Abst
503    
504    /**    /**
505       \brief       \brief
506       return the identifier of the matrix type to be used for the global stiffness matrix when a particular solver, package       return the identifier of the matrix type to be used for the global stiffness matrix when a particular solver, package, perconditioner,
507         and symmetric matrix is used.
508         \param solver
509         \param preconditioner
510         \param package
511         \param symmetry
512      */
513      FINLEY_DLL_API
514      virtual int getSystemMatrixTypeId(const int solver, const int preconditioner, const int package, const bool symmetry) const;
515    
516      /**
517         \brief
518         return the identifier of the transport problem type to be used when a particular solver, perconditioner, package
519       and symmetric matrix is used.       and symmetric matrix is used.
520       \param solver       \param solver
521         \param preconditioner
522         \param package
523       \param symmetry       \param symmetry
524    */    */
525    FINLEY_DLL_API    FINLEY_DLL_API
526    virtual int getSystemMatrixTypeId(const int solver, const int package, const bool symmetry) const;    virtual int getTransportTypeId(const int solver, const int preconditioner, const int package, const bool symmetry) const;
527    
528    /**    /**
529       \brief       \brief
# Line 477  class MeshAdapter : public escript::Abst Line 550  class MeshAdapter : public escript::Abst
550       This has to be implemented by the actual Domain adapter.       This has to be implemented by the actual Domain adapter.
551    */    */
552    FINLEY_DLL_API    FINLEY_DLL_API
553    virtual void saveVTK(const std::string& filename,const boost::python::dict& arg) const;    virtual void saveVTK(const std::string& filename,const boost::python::dict& arg,  const std::string& metadata, const std::string& metadata_schema) const;
554    
555    /**    /**
556       \brief       \brief
# Line 515  class MeshAdapter : public escript::Abst Line 588  class MeshAdapter : public escript::Abst
588    virtual void addPDEToRHS(escript::Data& rhs,    virtual void addPDEToRHS(escript::Data& rhs,
589                       const escript::Data& X, const escript::Data& Y,                       const escript::Data& X, const escript::Data& Y,
590                       const escript::Data& y, const escript::Data& y_contact) const;                       const escript::Data& y, const escript::Data& y_contact) const;
591      /**
592         \brief
593         adds a PDE onto a transport problem
594      */
595    
596      FINLEY_DLL_API
597      virtual void addPDEToTransportProblem(
598                         TransportProblemAdapter& tp, escript::Data& source,
599                         const escript::Data& M,
600                         const escript::Data& A, const escript::Data& B, const escript::Data& C,const  escript::Data& D,
601                         const  escript::Data& X,const  escript::Data& Y,
602                         const escript::Data& d, const escript::Data& y,
603                         const escript::Data& d_contact,const escript::Data& y_contact) const;
604    
605    
606    /**    /**
607       \brief       \brief
608      creates a SystemMatrixAdapter stiffness matrix an initializes it with zeros:      creates a SystemMatrixAdapter stiffness matrix and initializes it with zeros:
609    */    */
610    FINLEY_DLL_API    FINLEY_DLL_API
611    SystemMatrixAdapter newSystemMatrix(    SystemMatrixAdapter newSystemMatrix(
# Line 527  class MeshAdapter : public escript::Abst Line 614  class MeshAdapter : public escript::Abst
614                        const int column_blocksize,                        const int column_blocksize,
615                        const escript::FunctionSpace& column_functionspace,                        const escript::FunctionSpace& column_functionspace,
616                        const int type) const;                        const int type) const;
617      /**
618       \brief
619        creates a TransportProblemAdapter
620    
621      */
622    
623      FINLEY_DLL_API
624      TransportProblemAdapter newTransportProblem(
625                          const double theta,
626                          const int blocksize,
627                          const escript::FunctionSpace& functionspace,
628                          const int type) const;
629    
630    /**    /**
631       \brief returns locations in the FEM nodes       \brief returns locations in the FEM nodes
# Line 550  class MeshAdapter : public escript::Abst Line 649  class MeshAdapter : public escript::Abst
649       \brief comparison operators       \brief comparison operators
650    */    */
651    FINLEY_DLL_API    FINLEY_DLL_API
652    virtual bool operator==(const AbstractDomain& other) const;    virtual bool operator==(const escript::AbstractDomain& other) const;
653    FINLEY_DLL_API    FINLEY_DLL_API
654    virtual bool operator!=(const AbstractDomain& other) const;    virtual bool operator!=(const escript::AbstractDomain& other) const;
655    
656    /**    /**
657       \brief assigns new tag newTag to all samples of functionspace with a positive       \brief assigns new tag newTag to all samples of functionspace with a positive
# Line 562  class MeshAdapter : public escript::Abst Line 661  class MeshAdapter : public escript::Abst
661    FINLEY_DLL_API    FINLEY_DLL_API
662    virtual void setTags(const int functionSpaceType, const int newTag, const escript::Data& mask) const;    virtual void setTags(const int functionSpaceType, const int newTag, const escript::Data& mask) const;
663    
664      /**
665          \brief
666              return the number of tags in use and a pointer to an array with the number of tags in use
667      */
668      FINLEY_DLL_API
669      virtual int getNumberOfTagsInUse(int functionSpaceCode) const;
670    
671      FINLEY_DLL_API
672      virtual const int* borrowListOfTagsInUse(int functionSpaceCode) const;
673    
674    
675      /**
676         \brief Checks if this domain allows tags for the specified functionSpaceCode.
677      */
678      FINLEY_DLL_API
679      virtual
680      bool canTag(int functionSpaceCode) const;
681    
682    
683   protected:   protected:
684    
685   private:   private:
686      void extractArgsFromDict(const boost::python::dict& arg, int& numData,
687                                 char**& names, escriptDataC*& data,
688                                 escriptDataC**& dataPtr) const;
689    
690    //    //
691    // pointer to the externally created finley mesh    // pointer to the externally created finley mesh

Legend:
Removed from v.1326  
changed lines
  Added in v.2640

  ViewVC Help
Powered by ViewVC 1.1.26