1 // Project MULTIPR, IOLS WP1.2.1 - EDF/CS
2 // Partitioning/decimation module for the SALOME v3.2 platform
5 * \file MULTIPR_GaussLoc.hxx
7 * \brief Class MULTIPR_Obj.
8 * This class is used as an interface to implement MULTIPR services in the salome MODULE
9 * as described in the spec/design doc.
11 * \author Olivier LE ROUX - CS, Virtual Reality Dpt
16 #ifndef MULTIPR_OBJ_HXX
17 #define MULTIPR_OBJ_HXX
19 //*****************************************************************************
21 //*****************************************************************************
34 //*****************************************************************************
36 //*****************************************************************************
40 MULTIPR_OBJ_STATE_ERROR,
41 MULTIPR_OBJ_STATE_RESET,
42 MULTIPR_OBJ_STATE_SEQ_INIT,
43 MULTIPR_OBJ_STATE_SEQ,
44 MULTIPR_OBJ_STATE_DIS,
45 MULTIPR_OBJ_STATE_DIS_MEM
54 * Builds an empty Gauss reference (default constructor).
59 * Destructor. Removes everything.
64 * Resets this object in its state by default (empty). Cleans memory.
69 * Associate a MED file (sequential or distributed) with this object.
71 * - reset everything before starting
72 * - determine if the given file is a sequential (SEQ) or a distributed (DIS) MED file
73 * - read the ASCII master file if it is a distributed MED file
76 void create(const char* pMEDfilename);
78 //---------------------------------------------------------------------
79 // Basic accessors/mutators
80 //--------------------------------------------------------------------
83 * Returns true iff this obj represents a valid sequential MED file.
84 * \return true iff this obj represents a valid sequential MED file.
86 bool isValidSequentialMEDFile() const { return (mState == MULTIPR_OBJ_STATE_SEQ) || (mState == MULTIPR_OBJ_STATE_SEQ_INIT); }
89 * Returns true iff this obj represents a valid distributed MED file.
90 * \return true iff this obj represents a valid distributed MED file.
92 bool isValidDistributedMEDFile() const { return (mState == MULTIPR_OBJ_STATE_DIS) || (mState == MULTIPR_OBJ_STATE_DIS_MEM); }
95 * Defines the mesh to be processed.
96 * \param pMeshName name of the mesh to be partitionned.
98 void setMesh(const char* pMeshName);
101 * Returns the list of meshes contained in the sequential MED file.
102 * Assumes this object encapsulates a sequential MED file.
103 * \return the list of meshes contained in the sequential MED file.
105 std::vector<std::string> getMeshes() const;
108 * Returns the list of fields contained in the sequential MED file.
109 * Assumes this object encapsulates a sequential MED file.
110 * \return the list of fields contained in the sequential MED file.
112 std::vector<std::string> getFields() const;
115 * Returns the number of timestamps for a given field.
116 * Assumes this object encapsulates a sequential MED file.
117 * \param pFieldName name of any field.
118 * \return the number of timestamps for a given field; 0 if field not found.
120 int getTimeStamps(const char* pFieldName) const;
123 * Returns the name of all partitions.
124 * Assumes this object encapsulates a distributed MED file.
125 * \return the name of all partitions.
127 std::vector<std::string> getParts() const;
130 * Returns all information about a part.
131 * \param pPartName name of the part.
132 * \return all information about a part.
134 std::string getPartInfo(const char* pPartName) const;
136 //---------------------------------------------------------------------
138 //--------------------------------------------------------------------
141 * Creates a distributed MED file (v2.3) by extracting all the groups from the current mesh of the current MED sequential MED file.
143 * - the file is in MED format and can be read using MED file v2.3.
144 * - the file is sequential (not a distributed MED).
145 * - the file only contains TETRA10 elements (dimension of space and mesh is 3).
146 * - the file have no profil.
147 * \return the name of each part.
148 * \throw RuntimeException if any error occurs.
150 std::vector<std::string> partitionneDomaine();
153 * Creates a distributed MED file (V2.3) by splitting a group of a MED file previously created by partitionneDomaine.
155 * - the file is a distributed MED file, previously created by partitionneDomaine()
156 * (=> each part only contain 1 mesh, TETRA10 elements only)
158 * \param pPartName name of the part to be splitted.
159 * \param pNbParts number of parts; must be > 1.
160 * \param pPartitionner use value 0=MULTIPR_METIS for Metis or 1=MULTIPR_SCOTCH for Scotch.
161 * \return the name of each part.
162 * \throw RuntimeException if any error occurs.
164 std::vector<std::string> partitionneGrain(
165 const char* pPartName,
167 int pPartitionner=0);
170 * Creates 3 resolutions of the given part of a distributed MED file (V2.3).
172 * - the file is a distributed MED file, previously created by partitionneDomaine() or partitionneGrain()
173 * (=> each part only contain 1 mesh, TETRA10 elements only)
174 * \param pPartName name of the part to be decimated.
175 * \param pFieldName name of the field used for decimation.
176 * \param pFieldIt iteration (time step) of the field.
177 * \param pFilterName name of the filter to be used.
178 * \param pTmed threshold used for medium resolution.
179 * \param pTlow threshold used for low resolution; tmed must be less than tlow
180 * \param pTadius radius used to determine the neighbourhood.
181 * \param pBoxing number of cells along each axis; must be >= 1; e.g. if 100 then acceleration grid will have 100*100*100 = 10**6 cells.
182 * \return the name of each part.
183 * \throw RuntimeException if any error occurs.
185 std::vector<std::string> decimePartition(
186 const char* pPartName,
187 const char* pFieldName,
189 const char* pFilterName,
195 //---------------------------------------------------------------------
197 //---------------------------------------------------------------------
200 * Saves the associated MED file if necessary.
201 * \throw IOException if any i/o error occurs.
206 * Dumps any Obj to the given output stream.
207 * \param pOs any output stream.
209 * \return the output stream pOs.
211 friend std::ostream& operator<<(std::ostream& pOs, Obj& pO);
216 * Returns the list of parts contained in the current distributed mesh.
217 * \return the list of parts contained in the current distributed mesh.
218 * \throw IllegalStateException if the distributed mesh does not still exist.
220 std::vector<std::string> getListParts() const;
224 std::string mMEDfilename; /**< Name of the MED file: sequential or distributed. */
225 std::string mMeshName; /**< Mesh to be partitionned. */
226 ObjState mState; /**< State of this object. */
227 MeshDis* mMeshDis; /**< Distributed mesh. */
232 // do not allow copy constructor
236 Obj& operator=(const Obj&);
238 // do not allow operator ==
239 bool operator==(const Obj&);
244 } // namespace MULTIPR
247 #endif // MULTIPR_OBJ_HXX