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 * Returns the name of the associated MED file.
96 * \return the name of the associated MED file.
98 std::string getMEDFilename() const { return mMEDfilename; }
101 * Defines the mesh to be processed.
102 * \param pMeshName name of the mesh to be partitionned.
104 void setMesh(const char* pMeshName);
107 * Returns the list of meshes contained in the sequential MED file.
108 * Assumes this object encapsulates a sequential MED file.
109 * \return the list of meshes contained in the sequential MED file.
111 std::vector<std::string> getMeshes() const;
114 * Returns the list of fields contained in the sequential MED file.
115 * Assumes this object encapsulates a sequential MED file.
116 * \return the list of fields contained in the sequential MED file.
118 std::vector<std::string> getFields() const;
121 * Returns the number of timestamps for a given field.
122 * Assumes this object encapsulates a sequential MED file.
123 * \param pFieldName name of any field.
124 * \return the number of timestamps for a given field; 0 if field not found.
126 int getTimeStamps(const char* pFieldName) const;
129 * Returns the name of all partitions.
130 * Assumes this object encapsulates a distributed MED file.
131 * \return the name of all partitions.
133 std::vector<std::string> getParts() const;
136 * Returns all information about a part.
137 * \param pPartName name of the part.
138 * \return all information about a part.
140 std::string getPartInfo(const char* pPartName) const;
143 * Removes all the part beginning by pPrefixPartName from the distributed MED file.
144 * Example: if pPrefixPartName="PART_4" => remove "PART_4" and all sub-parts "PART_4_*", but not "PART41".
145 * Assume this object encapsulates a distributed MED file.
146 * \param pPrefixPartName name of the part.
148 void removeParts(const char* pPrefixPartName);
151 //---------------------------------------------------------------------
153 //--------------------------------------------------------------------
156 * Creates a distributed MED file (v2.3) by extracting all the groups from the current mesh of the current MED sequential MED file.
158 * - the file is in MED format and can be read using MED file v2.3.
159 * - the file is sequential (not a distributed MED).
160 * - the file only contains TETRA10 elements (dimension of space and mesh is 3).
161 * - the file have no profil.
162 * \return the name of each part.
163 * \throw RuntimeException if any error occurs.
165 std::vector<std::string> partitionneDomaine();
168 * Creates a distributed MED file (V2.3) by splitting a group of a MED file previously created by partitionneDomaine.
170 * - the file is a distributed MED file, previously created by partitionneDomaine()
171 * (=> each part only contain 1 mesh, TETRA10 elements only)
173 * \param pPartName name of the part to be splitted.
174 * \param pNbParts number of parts; must be > 1.
175 * \param pPartitionner use value 0=MULTIPR_METIS for Metis or 1=MULTIPR_SCOTCH for Scotch.
176 * \return the name of each part.
177 * \throw RuntimeException if any error occurs.
179 std::vector<std::string> partitionneGrain(
180 const char* pPartName,
182 int pPartitionner=0);
185 * Creates 3 resolutions of the given part of a distributed MED file (V2.3).
187 * - the file is a distributed MED file, previously created by partitionneDomaine() or partitionneGrain()
188 * (=> each part only contain 1 mesh, TETRA10 elements only)
189 * \param pPartName name of the part to be decimated.
190 * \param pFieldName name of the field used for decimation.
191 * \param pFieldIt iteration (time step) of the field.
192 * \param pFilterName name of the filter to be used.
193 * \param pTmed threshold used for medium resolution.
194 * \param pTlow threshold used for low resolution; tmed must be less than tlow
195 * \param pTadius radius used to determine the neighbourhood.
196 * \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.
197 * \return the name of each part.
198 * \throw RuntimeException if any error occurs.
200 std::vector<std::string> decimePartition(
201 const char* pPartName,
202 const char* pFieldName,
204 const char* pFilterName,
211 * Returns useful information to configure decimation parameters.
212 * Depends on part, field and filter: generic operation.
213 * \param pPartName name of the part.
214 * \param pFieldName name of the field used for decimation.
215 * \param pFieldIt iteration (time step) of the field.
216 * \param pFilterName name of the filter to be used.
217 * \param pFilterParams params to be used with the filter (depends on filter; this string will be parsed).
219 std::string evalDecimationParams(
220 const char* pPartName,
221 const char* pFieldName,
223 const char* pFilterName,
224 const char* pFilterParams);
227 //---------------------------------------------------------------------
229 //---------------------------------------------------------------------
232 * Saves the associated MED file if necessary.
233 * \param pPath path where to save the file.
234 * \throw IOException if any i/o error occurs.
236 void save(const char* pPath);
239 * Dumps any Obj to the given output stream.
240 * \param pOs any output stream.
242 * \return the output stream pOs.
244 friend std::ostream& operator<<(std::ostream& pOs, Obj& pO);
249 * Returns the list of parts contained in the current distributed mesh.
250 * \return the list of parts contained in the current distributed mesh.
251 * \throw IllegalStateException if the distributed mesh does not still exist.
253 std::vector<std::string> getListParts() const;
257 std::string mMEDfilename; /**< Name of the MED file: sequential or distributed. */
258 std::string mMeshName; /**< Mesh to be partitionned. */
259 ObjState mState; /**< State of this object. */
260 MeshDis* mMeshDis; /**< Distributed mesh. */
265 // do not allow copy constructor
269 Obj& operator=(const Obj&);
271 // do not allow operator ==
272 bool operator==(const Obj&);
277 } // namespace MULTIPR
280 #endif // MULTIPR_OBJ_HXX