EpetraExt Package Browser (Single Doxygen Collection) Development
EpetraExt_MatlabEngine.h
Go to the documentation of this file.
00001 //@HEADER
00002 // ***********************************************************************
00003 //
00004 //     EpetraExt: Epetra Extended - Linear Algebra Services Package
00005 //                 Copyright (2011) Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 //@HEADER
00041 
00042 #ifndef MATLAB_ENGINE_H
00043 #define MATLAB_ENGINE_H
00044 #include <Epetra_ConfigDefs.h>
00045 
00046 #ifdef EPETRA_MPI
00047 #include "Epetra_MpiComm.h"
00048 #else
00049 #include "Epetra_SerialComm.h"
00050 #endif
00051 #include "Epetra_Comm.h"
00052 
00053 // the following deal with matlab provided headers:
00054 #include "engine.h"
00055 #include "mex.h"
00056 #undef printf  // matlab has its own printf that we don't want to use
00057 
00058 class Epetra_MultiVector;
00059 class Epetra_RowMatrix;
00060 class Epetra_CrsGraph;
00061 class Epetra_SerialDenseMatrix;
00062 class Epetra_BlockMap;
00063 class Epetra_IntSerialDenseMatrix;
00064 class Epetra_CrsMatrix;
00065 
00066 namespace EpetraExt {
00067 
00069 
00115 class EpetraExt_MatlabEngine {
00116 
00117   public:
00118 
00120 
00122 
00128   EpetraExt_MatlabEngine(const Epetra_Comm& Comm);
00129 
00131   ~EpetraExt_MatlabEngine();
00133   
00135 
00137 
00151   int EvalString (char* command, char* outputBuffer = NULL, int outputBufferSize = -1);
00152 
00154 
00156 
00158 
00168   int PutMultiVector(const Epetra_MultiVector& A, const char* variableName);
00169 
00171 
00186   int PutRowMatrix(const Epetra_RowMatrix& A, const char* variableName, bool transA);
00187 
00189   int PutCrsGraph(const Epetra_CrsGraph& A, const char* variableName, bool transA);
00190 
00192 
00207   int PutSerialDenseMatrix(const Epetra_SerialDenseMatrix& A, const char* variableName, int proc=0);
00208 
00210 
00225   int PutIntSerialDenseMatrix(const Epetra_IntSerialDenseMatrix& A, const char* variableName, int proc=0);
00226 
00228 
00243   int PutBlockMap(const Epetra_BlockMap& blockMap, const char* variableName, bool transA);
00244   
00246 
00265   int PutIntoMatlab(const char* variableName, mxArray* matlabA);
00266 
00268 
00270 
00272 
00283   int GetMultiVector(const char* variableName, Epetra_MultiVector& A);
00284   
00286 
00300   int GetSerialDenseMatrix(const char* variableName, Epetra_SerialDenseMatrix& A, int proc=0);
00301   
00303 
00317   int GetIntSerialDenseMatrix(const char* variableName, Epetra_IntSerialDenseMatrix& A, int proc=0);
00318   
00320 
00339   int GetCrsMatrix(const char* variableName, Epetra_CrsMatrix& A, bool getTrans);
00340   
00342     
00344     
00346 
00366   int GetmxArrayDimensions(mxArray* matlabA, bool& isSparse, int& numRows, int& numCols, int& numNonZeros);
00367   
00369 
00382   int GetmxArray(const char* variableName, mxArray** matlabA);
00383   
00385 
00386  private:
00387   // the Matlab Engine object provided by libeng and engine.h
00388   Engine* Engine_ ;
00389   // the Epetra_Comm object that will be used for all communication
00390   const Epetra_Comm& Comm_ ;
00391 
00392 };
00393 } // namespace EpetraExt
00394 
00395 #endif /* MATLAB_ENGINE_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines