1 // Copyright (C) 2010-2015 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 // Author : Anthony Geay
21 #include "vtkMEDReader.h"
22 #include "vtkGenerateVectors.h"
24 #include "vtkMultiBlockDataSet.h"
25 #include "vtkInformation.h"
26 #include "vtkDataSetAttributes.h"
27 #include "vtkStringArray.h"
28 #include "vtkMutableDirectedGraph.h"
29 #include "vtkInformationStringKey.h"
31 #include "vtkUnsignedCharArray.h"
32 #include "vtkInformationVector.h"
33 #include "vtkSmartPointer.h"
34 #include "vtkVariantArray.h"
35 #include "vtkExecutive.h"
36 #include "vtkStreamingDemandDrivenPipeline.h"
37 #include "vtkMultiTimeStepAlgorithm.h"
38 #include "vtkUnstructuredGrid.h"
39 #include "vtkInformationQuadratureSchemeDefinitionVectorKey.h"
40 #include "vtkQuadratureSchemeDefinition.h"
41 #include "vtkPointData.h"
42 #include "vtkCellData.h"
43 #include "vtkCellType.h"
44 #include "vtkCellArray.h"
45 #include "vtkDoubleArray.h"
46 #include "vtkObjectFactory.h"
47 #ifdef MEDREADER_USE_MPI
48 #include "vtkMultiProcessController.h"
51 #include "MEDFileFieldRepresentationTree.hxx"
60 * This class stores properties in loading state mode (pvsm) when the MED file has not been read yet.
61 * The file is not read beacause FileName has not been informed yet ! So this class stores properties of vtkMEDReader instance that
62 * owns it and wait the vtkMEDReader::SetFileName to apply properties afterwards.
67 PropertyKeeper(vtkMEDReader *master):_master(master),IsGVActivated(false),GVValue(0),IsCMActivated(false),CMValue(0) { }
68 void assignPropertiesIfNeeded();
69 bool arePropertiesOnTreeToSetAfter() const;
71 void pushFieldStatusEntry(const char* name, int status);
72 void pushGenerateVectorsValue(int value);
73 void pushChangeModeValue(int value);
74 void pushTimesFlagsStatusEntry(const char* name, int status);
76 // pool of pairs to assign in SetFieldsStatus if needed. The use case is the load using pvsm.
77 std::vector< std::pair<std::string,int> > SetFieldsStatusPairs;
85 std::vector< std::pair<std::string,int> > TimesFlagsStatusPairs;
86 vtkMEDReader *_master;
89 void PropertyKeeper::assignPropertiesIfNeeded()
91 if(!this->SetFieldsStatusPairs.empty())
93 for(std::vector< std::pair<std::string,int> >::const_iterator it=this->SetFieldsStatusPairs.begin();it!=this->SetFieldsStatusPairs.end();it++)
94 _master->SetFieldsStatus((*it).first.c_str(),(*it).second);
95 this->SetFieldsStatusPairs.clear();
97 if(!this->TimesFlagsStatusPairs.empty())
99 for(std::vector< std::pair<std::string,int> >::const_iterator it=this->TimesFlagsStatusPairs.begin();it!=this->TimesFlagsStatusPairs.end();it++)
100 _master->SetTimesFlagsStatus((*it).first.c_str(),(*it).second);
101 this->TimesFlagsStatusPairs.clear();
103 if(this->IsGVActivated)
105 _master->GenerateVectors(this->GVValue);
106 this->IsGVActivated=false;
108 if(this->IsCMActivated)
110 _master->ChangeMode(this->CMValue);
111 this->IsCMActivated=false;
115 void PropertyKeeper::pushFieldStatusEntry(const char* name, int status)
118 for(std::vector< std::pair<std::string,int> >::const_iterator it=this->SetFieldsStatusPairs.begin();it!=this->SetFieldsStatusPairs.end() && !found;it++)
119 found=(*it).first==name;
121 this->SetFieldsStatusPairs.push_back(std::pair<std::string,int>(name,status));
124 void PropertyKeeper::pushTimesFlagsStatusEntry(const char* name, int status)
127 for(std::vector< std::pair<std::string,int> >::const_iterator it=this->TimesFlagsStatusPairs.begin();it!=this->TimesFlagsStatusPairs.end() && !found;it++)
128 found=(*it).first==name;
130 this->TimesFlagsStatusPairs.push_back(std::pair<std::string,int>(name,status));
133 void PropertyKeeper::pushGenerateVectorsValue(int value)
135 this->IsGVActivated=true;
139 void PropertyKeeper::pushChangeModeValue(int value)
141 this->IsCMActivated=true;
145 bool PropertyKeeper::arePropertiesOnTreeToSetAfter() const
147 return !SetFieldsStatusPairs.empty();
150 class vtkMEDReader::vtkMEDReaderInternal
154 vtkMEDReaderInternal(vtkMEDReader *master):TK(0),IsMEDOrSauv(true),IsStdOrMode(false),GenerateVect(false),SIL(0),LastLev0(-1),FirstCall0(2),PK(master),MyMTime(0)
166 ~vtkMEDReaderInternal()
172 MEDFileFieldRepresentationTree Tree;
174 std::string FileName;
175 //when true the file is MED file. when false it is a Sauv file
177 //when false -> std, true -> mode. By default std (false).
179 //when false -> do nothing. When true cut off or extend to nbOfCompo=3 vector arrays.
181 std::string DftMeshName;
182 // Store the vtkMutableDirectedGraph that represents links between family, groups and cell types
183 vtkMutableDirectedGraph* SIL;
184 // store the lev0 id in Tree corresponding to the TIME_STEPS in the pipeline.
186 // The property keeper is usable only in pvsm mode.
189 std::set<std::string> _wonderful_set;// this set is used by SetFieldsStatus method to detect the fact that SetFieldsStatus has been called for all items ! Great Items are not sorted ! Why ?
190 std::map<std::string,bool> _wonderful_ref;// this map stores the state before a SetFieldsStatus status.
192 unsigned char FirstCall0;
195 vtkStandardNewMacro(vtkMEDReader);
197 vtkMEDReader::vtkMEDReader():Internal(new vtkMEDReaderInternal(this))
199 this->SetNumberOfInputPorts(0);
200 this->SetNumberOfOutputPorts(1);
203 vtkMEDReader::~vtkMEDReader()
205 delete this->Internal;
209 void vtkMEDReader::Reload(int a)
213 std::cerr << "vtkMEDReader::Reload" << a << std::endl;
214 std::string fName((const char *)this->GetFileName());
215 delete this->Internal;
216 this->Internal=new vtkMEDReaderInternal(this);
217 this->SetFileName(fName.c_str());
220 int vtkMEDReader::GetServerModifTime()
222 if( !this->Internal )
224 return this->Internal->MyMTime;
227 void vtkMEDReader::GenerateVectors(int val)
229 if ( !this->Internal )
232 if(this->Internal->FileName.empty())
234 this->Internal->PK.pushGenerateVectorsValue(val);
237 //not pvsm mode (general case)
238 bool val2((bool)val);
239 if(val2!=this->Internal->GenerateVect)
241 this->Internal->GenerateVect=val2;
246 void vtkMEDReader::ChangeMode(int newMode)
248 if ( !this->Internal )
251 if(this->Internal->FileName.empty())
253 this->Internal->PK.pushChangeModeValue(newMode);
256 //not pvsm mode (general case)
257 this->Internal->IsStdOrMode=newMode!=0;
258 //std::cerr << "vtkMEDReader::ChangeMode : " << this->Internal->IsStdOrMode << std::endl;
262 const char *vtkMEDReader::GetSeparator()
264 return MEDFileFieldRepresentationLeavesArrays::ZE_SEP;
267 void vtkMEDReader::SetFileName(const char *fname)
273 this->Internal->FileName=fname;
274 std::size_t pos(this->Internal->FileName.find_last_of('.'));
275 if(pos!=std::string::npos)
277 std::string ext(this->Internal->FileName.substr(pos));
278 if(ext.find("sauv")!=std::string::npos)
279 this->Internal->IsMEDOrSauv=false;
281 if(this->Internal->Tree.getNumberOfLeavesArrays()==0)
283 int iPart(-1),nbOfParts(-1);
284 #ifdef MEDREADER_USE_MPI
285 vtkMultiProcessController *vmpc(vtkMultiProcessController::GetGlobalController());
288 iPart=vmpc->GetLocalProcessId();
289 nbOfParts=vmpc->GetNumberOfProcesses();
292 this->Internal->Tree.loadMainStructureOfFile(this->Internal->FileName.c_str(),this->Internal->IsMEDOrSauv,iPart,nbOfParts);
293 if(!this->Internal->PK.arePropertiesOnTreeToSetAfter())
294 this->Internal->Tree.activateTheFirst();//This line manually initialize the status of server (this) with the remote client.
295 this->Internal->TK.setMaxNumberOfTimeSteps(this->Internal->Tree.getMaxNumberOfTimeSteps());
298 this->Internal->PK.assignPropertiesIfNeeded();
300 catch(INTERP_KERNEL::Exception& e)
302 delete this->Internal;
304 std::ostringstream oss;
305 oss << "Exception has been thrown in vtkMEDReader::SetFileName : " << e.what() << std::endl;
306 if(this->HasObserver("ErrorEvent") )
307 this->InvokeEvent("ErrorEvent",const_cast<char *>(oss.str().c_str()));
309 vtkOutputWindowDisplayErrorText(const_cast<char *>(oss.str().c_str()));
310 vtkObject::BreakOnError();
314 char *vtkMEDReader::GetFileName()
318 return const_cast<char *>(this->Internal->FileName.c_str());
321 int vtkMEDReader::RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
323 //std::cerr << "########################################## RequestInformation ##########################################" << std::endl;
328 vtkInformation *outInfo(outputVector->GetInformationObject(0));
329 outInfo->Set(vtkDataObject::DATA_TYPE_NAME(),"vtkMultiBlockDataSet");
330 this->UpdateSIL(outInfo);
333 this->PublishTimeStepsIfNeeded(outInfo,dummy);
335 catch(INTERP_KERNEL::Exception& e)
337 std::ostringstream oss;
338 oss << "Exception has been thrown in vtkMEDReader::RequestInformation : " << e.what() << std::endl;
339 if(this->HasObserver("ErrorEvent") )
340 this->InvokeEvent("ErrorEvent",const_cast<char *>(oss.str().c_str()));
342 vtkOutputWindowDisplayErrorText(const_cast<char *>(oss.str().c_str()));
343 vtkObject::BreakOnError();
349 int vtkMEDReader::RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
351 //std::cerr << "########################################## RequestData ##########################################";
356 vtkInformation *outInfo(outputVector->GetInformationObject(0));
357 vtkMultiBlockDataSet *output(vtkMultiBlockDataSet::SafeDownCast(outInfo->Get(vtkDataObject::DATA_OBJECT())));
358 bool isUpdated(false);
360 if(outInfo->Has(vtkStreamingDemandDrivenPipeline::UPDATE_TIME_STEP()))
361 reqTS=outInfo->Get(vtkStreamingDemandDrivenPipeline::UPDATE_TIME_STEP());
362 //std::cerr << reqTS << std::endl;
363 this->FillMultiBlockDataSetInstance(output,reqTS);
364 output->GetInformation()->Set(vtkDataObject::DATA_TIME_STEP(),reqTS);
365 this->UpdateSIL(outInfo);
366 //this->UpdateProgress((float) progress/((float) maxprogress-1));
368 catch(INTERP_KERNEL::Exception& e)
370 std::cerr << "Exception has been thrown in vtkMEDReader::RequestData : " << e.what() << std::endl;
376 void vtkMEDReader::SetFieldsStatus(const char* name, int status)
378 if( !this->Internal )
381 //this->Internal->_wonderful_set.insert(name);
382 if(this->Internal->FileName.empty())
384 this->Internal->PK.pushFieldStatusEntry(name,status);
387 if(this->Internal->_wonderful_set.empty())
388 this->Internal->_wonderful_ref=this->Internal->Tree.dumpState();// start of SetFieldsStatus serie -> store ref to compare at the end of the SetFieldsStatus serie.
389 this->Internal->_wonderful_set.insert(name);
390 //not pvsm mode (general case)
393 this->Internal->Tree.changeStatusOfAndUpdateToHaveCoherentVTKDataSet(this->Internal->Tree.getIdHavingZeName(name),status);
394 if(this->Internal->_wonderful_set.size()==GetNumberOfFieldsTreeArrays())
396 if(this->Internal->_wonderful_ref!=this->Internal->Tree.dumpState())
398 if(!this->Internal->PluginStart0())
402 this->Internal->MyMTime++;
404 this->Internal->_wonderful_set.clear();
407 catch(INTERP_KERNEL::Exception& e)
409 if(!this->Internal->FileName.empty())
411 std::cerr << "vtkMEDReader::SetFieldsStatus error : " << e.what() << " *** WITH STATUS=" << status << endl;
417 int vtkMEDReader::GetNumberOfFieldsTreeArrays()
421 return this->Internal->Tree.getNumberOfLeavesArrays();
422 //std::cerr << "vtkMEDReader::GetNumberOfFieldsTreeArrays called ! " << ret << std::endl;
425 const char *vtkMEDReader::GetFieldsTreeArrayName(int index)
429 return this->Internal->Tree.getNameOfC(index);
430 //std::cerr << "vtkMEDReader::GetFieldsTreeArrayName(" << index << ") called ! " << ret << std::endl;
433 int vtkMEDReader::GetFieldsTreeArrayStatus(const char *name)
438 int zeId(this->Internal->Tree.getIdHavingZeName(name));
439 int ret(this->Internal->Tree.getStatusOf(zeId));
443 void vtkMEDReader::SetTimesFlagsStatus(const char *name, int status)
448 if(this->Internal->FileName.empty())
450 this->Internal->PK.pushTimesFlagsStatusEntry(name,status);
453 //not pvsm mode (general case)
455 std::istringstream iss(name); iss >> pos;
456 this->Internal->TK.getTimesFlagArray()[pos].first=(bool)status;
457 if(pos==this->Internal->TK.getTimesFlagArray().size()-1)
458 if(!this->Internal->PluginStart0())
461 //this->Internal->TK.printSelf(std::cerr);
465 int vtkMEDReader::GetNumberOfTimesFlagsArrays()
469 return (int)this->Internal->TK.getTimesFlagArray().size();
472 const char *vtkMEDReader::GetTimesFlagsArrayName(int index)
474 return this->Internal->TK.getTimesFlagArray()[index].second.c_str();
477 int vtkMEDReader::GetTimesFlagsArrayStatus(const char *name)
482 std::istringstream iss(name); iss >> pos;
483 return (int)this->Internal->TK.getTimesFlagArray()[pos].first;
486 void vtkMEDReader::UpdateSIL(vtkInformation *info)
490 vtkMutableDirectedGraph *sil(vtkMutableDirectedGraph::New());
491 std::string meshName(this->BuildSIL(sil));
492 if(meshName!=this->Internal->DftMeshName)
494 if(this->Internal->SIL)
495 this->Internal->SIL->Delete();
496 this->Internal->SIL=sil;
497 this->Internal->DftMeshName=meshName;
498 info->Set(vtkDataObject::SIL(),this->Internal->SIL);
499 //request->AppendUnique(vtkExecutive::KEYS_TO_COPY(),vtkDataObject::SIL());
508 * The returned string is the name of the mesh activated which groups and families are in \a sil.
510 std::string vtkMEDReader::BuildSIL(vtkMutableDirectedGraph* sil)
513 return std::string();
515 vtkSmartPointer<vtkVariantArray> childEdge(vtkSmartPointer<vtkVariantArray>::New());
516 childEdge->InsertNextValue(0);
517 vtkSmartPointer<vtkVariantArray> crossEdge(vtkSmartPointer<vtkVariantArray>::New());
518 crossEdge->InsertNextValue(1);
519 // CrossEdge is an edge linking hierarchies.
520 vtkUnsignedCharArray* crossEdgesArray=vtkUnsignedCharArray::New();
521 crossEdgesArray->SetName("CrossEdges");
522 sil->GetEdgeData()->AddArray(crossEdgesArray);
523 crossEdgesArray->Delete();
524 std::vector<std::string> names;
525 // Now build the hierarchy.
526 vtkIdType rootId=sil->AddVertex();
527 names.push_back("SIL");
528 // Add global fields root
529 vtkIdType fieldsRoot(sil->AddChild(rootId,childEdge));
530 names.push_back("FieldsStatusTree");
531 this->Internal->Tree.feedSIL(sil,fieldsRoot,childEdge,names);
532 vtkIdType meshesFamsGrpsRoot(sil->AddChild(rootId,childEdge));
533 names.push_back("MeshesFamsGrps");
534 std::string dftMeshName(this->Internal->Tree.feedSILForFamsAndGrps(sil,meshesFamsGrpsRoot,childEdge,names));
535 // This array is used to assign names to nodes.
536 vtkStringArray *namesArray(vtkStringArray::New());
537 namesArray->SetName("Names");
538 namesArray->SetNumberOfTuples(sil->GetNumberOfVertices());
539 sil->GetVertexData()->AddArray(namesArray);
540 namesArray->Delete();
541 std::vector<std::string>::const_iterator iter;
543 for(cc=0, iter=names.begin(); iter!=names.end(); ++iter, ++cc)
544 namesArray->SetValue(cc,(*iter).c_str());
548 double vtkMEDReader::PublishTimeStepsIfNeeded(vtkInformation *outInfo, bool& isUpdated)
554 std::vector<double> tsteps;
555 if(!this->Internal->IsStdOrMode)
556 tsteps=this->Internal->Tree.getTimeSteps(lev0,this->Internal->TK);
558 { tsteps.resize(1); tsteps[0]=0.; }
560 if(lev0!=this->Internal->LastLev0)
564 timeRange[0]=tsteps.front();
565 timeRange[1]=tsteps.back();
566 outInfo->Set(vtkStreamingDemandDrivenPipeline::TIME_STEPS(),&tsteps[0],tsteps.size());
567 outInfo->Set(vtkStreamingDemandDrivenPipeline::TIME_RANGE(),timeRange,2);
568 this->Internal->LastLev0=lev0;
570 return tsteps.front();
573 void vtkMEDReader::FillMultiBlockDataSetInstance(vtkMultiBlockDataSet *output, double reqTS)
575 if( !this->Internal )
577 std::string meshName;
578 vtkDataSet *ret(this->Internal->Tree.buildVTKInstance(this->Internal->IsStdOrMode,reqTS,meshName,this->Internal->TK));
579 if(this->Internal->GenerateVect)
581 vtkGenerateVectors::Operate(ret->GetPointData());
582 vtkGenerateVectors::Operate(ret->GetCellData());
583 vtkGenerateVectors::Operate(ret->GetFieldData());
585 output->SetBlock(0,ret);
589 void vtkMEDReader::PrintSelf(ostream& os, vtkIndent indent)
591 this->Superclass::PrintSelf(os, indent);