idl/MG_ADAPT.idl

   1 // Copyright (C) 2020-2021  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef MG_ADAPT_IDL
  21 #define MG_ADAPT_IDL
  22
  23 #include "SALOME_Component.idl"
  24 #include "SALOME_Exception.idl"
  25 #include "SALOME_GenericObj.idl"
  26 #include "SALOMEDS.idl"
  27 #include "SMESH_Mesh.idl"
  28
  29 module SMESH
  30 {
  31   struct MgAdaptHypothesisData
  32   {
  33     string  myFileInDir, myMeshFileIn, myInMeshName, myMeshFileBackground, myOutMeshName,
  34             myMeshFileOut, myFileOutDir, myFileSizeMapDir, myFieldName;
  35     boolean fromMedFile;
  36     boolean myPublish, myMeshOutMed;
  37     boolean myUseLocalMap, myUseBackgroundMap, myUseConstantValue;
  38     double  myConstantValue;
  39     long    myRank, myTimeStep;
  40     boolean myUseNoTimeStep, myUseLastTimeStep, myUseChosenTimeStep;
  41     string  myWorkingDir, myLogFile;
  42     boolean myPrintLogInFile, myKeepFiles, myRemoveLogOnSuccess;
  43     long    myVerboseLevel;
  44   };
  45
  46   interface MG_ADAPT : SALOME::GenericObj
  47   {
  48     void setData(inout MgAdaptHypothesisData data);
  49
  50     void setMedFileIn(in string MedFileIn);
  51     string getMedFileIn();
  52
  53     void setMedFileOut(in string MedFileOut);
  54     string getMedFileOut();
  55
  56     void setMeshName(in string s);
  57     string getMeshName();
  58
  59     void setMeshNameOut(in string s);
  60     string getMeshNameOut();
  61
  62     void setMeshOutMed(in boolean b);
  63     boolean getMeshOutMed();
  64
  65     void setPublish(in boolean b);
  66     boolean getPublish();
  67
  68     void setSizeMapFieldName(in string s);
  69     string getSizeMapFieldName();
  70
  71     void setTimeStep(in long s);
  72     long getTimeStep();
  73
  74     void setTimeStepRank(in long s, in long f);
  75     long getRank();
  76
  77     void setTimeStepRankLast();
  78     void setNoTimeStep();
  79
  80     void setLogFile(in string f);
  81     string getLogFile();
  82
  83     void setVerbosityLevel(in long f);
  84     long getVerbosityLevel();
  85
  86     void setRemoveOnSuccess(in boolean f);
  87     boolean getRemoveOnSuccess();
  88
  89     MgAdaptHypothesisData getData();
  90
  91     void setUseLocalMap(in boolean f);
  92     boolean getUseLocalMap();
  93
  94     void setUseBackgroundMap(in boolean f);
  95     boolean getUseBackgroundMap();
  96
  97     void setUseConstantValue(in boolean f);
  98     boolean getUseConstantValue();
  99
 100     void setConstantSize(in double f);
 101     double getConstantSize();
 102
 103     void setSizeMapFile(in string f);
 104     string getSizeMapFile();
 105
 106     void setFromMedFile(in boolean f);
 107     boolean isFromMedFile();
 108
 109     void setKeepWorkingFiles(in boolean f);
 110     boolean getKeepWorkingFiles();
 111
 112     void setPrintLogInFile(in boolean f);
 113     boolean getPrintLogInFile();
 114
 115     void setWorkingDir(in string f);
 116     string getWorkingDir();
 117
 118     void setSizeMapType(in string f);
 119     boolean setAll();
 120     string getCommandToRun();
 121     void compute() raises(SALOME::SALOME_Exception);
 122     string getErrMsg();
 123     string getFileName();
 124     string getExeName();
 125     void copyMgAdaptHypothesisData(in MgAdaptHypothesisData f);
 126
 127     //void checkDirPath(inout string f);
 128
 129     boolean hasOptionDefined(in string optionName);
 130     void setOptionValue(in string optionName, in string optionValue) raises (SALOME::SALOME_Exception);
 131     string getOptionValue(in string optionName, inout boolean isDefault) raises (SALOME::SALOME_Exception);
 132     SMESH::string_array getCustomOptionValuesStrVec();
 133     SMESH::string_array getOptionValuesStrVec();
 134   };
 135
 136   typedef MG_ADAPT MG_ADAPT_HYPOTHESIS;
 137   interface MG_ADAPT_OBJECT : SALOME::GenericObj
 138   {
 139     void setMeshIn(in SMESH_Mesh theMesh)    raises (SALOME::SALOME_Exception);
 140     void setMEDFileIn(in string f)           raises (SALOME::SALOME_Exception);
 141     void setMEDFileOut(in string f)          raises (SALOME::SALOME_Exception);
 142     void setMEDFileBackground(in string f)   raises (SALOME::SALOME_Exception);
 143     void AddHypothesis(in MG_ADAPT mg)       raises (SALOME::SALOME_Exception);
 144     long Compute(in boolean Publish)         raises (SALOME::SALOME_Exception);
 145   };
 146 };
 147
 148 #endif // MG_ADAPT_IDL