1 // Copyright (C) 2010-2014 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"
48 #include "MEDFileFieldRepresentationTree.hxx"
56 * This class stores properties in loading state mode (pvsm) when the MED file has not been read yet.
57 * The file is not read beacause FileName has not been informed yet ! So this class stores properties of vtkMEDReader instance that
58 * owns it and wait the vtkMEDReader::SetFileName to apply properties afterwards.
63 PropertyKeeper(vtkMEDReader *master):_master(master),IsGVActivated(false),GVValue(0),IsCMActivated(false),CMValue(0) { }
64 void assignPropertiesIfNeeded();
65 bool arePropertiesOnTreeToSetAfter() const;
67 void pushFieldStatusEntry(const char* name, int status);
68 void pushGenerateVectorsValue(int value);
69 void pushChangeModeValue(int value);
70 void pushTimesFlagsStatusEntry(const char* name, int status);
72 // pool of pairs to assign in SetFieldsStatus if needed. The use case is the load using pvsm.
73 std::vector< std::pair<std::string,int> > SetFieldsStatusPairs;
81 std::vector< std::pair<std::string,int> > TimesFlagsStatusPairs;
82 vtkMEDReader *_master;
85 void PropertyKeeper::assignPropertiesIfNeeded()
87 if(!this->SetFieldsStatusPairs.empty())
89 for(std::vector< std::pair<std::string,int> >::const_iterator it=this->SetFieldsStatusPairs.begin();it!=this->SetFieldsStatusPairs.end();it++)
90 _master->SetFieldsStatus((*it).first.c_str(),(*it).second);
91 this->SetFieldsStatusPairs.clear();
93 if(!this->TimesFlagsStatusPairs.empty())
95 for(std::vector< std::pair<std::string,int> >::const_iterator it=this->TimesFlagsStatusPairs.begin();it!=this->TimesFlagsStatusPairs.end();it++)
96 _master->SetTimesFlagsStatus((*it).first.c_str(),(*it).second);
97 this->TimesFlagsStatusPairs.clear();
99 if(this->IsGVActivated)
101 _master->GenerateVectors(this->GVValue);
102 this->IsGVActivated=false;
104 if(this->IsCMActivated)
106 _master->ChangeMode(this->CMValue);
107 this->IsCMActivated=false;
111 void PropertyKeeper::pushFieldStatusEntry(const char* name, int status)
114 for(std::vector< std::pair<std::string,int> >::const_iterator it=this->SetFieldsStatusPairs.begin();it!=this->SetFieldsStatusPairs.end() && !found;it++)
115 found=(*it).first==name;
117 this->SetFieldsStatusPairs.push_back(std::pair<std::string,int>(name,status));
120 void PropertyKeeper::pushTimesFlagsStatusEntry(const char* name, int status)
123 for(std::vector< std::pair<std::string,int> >::const_iterator it=this->TimesFlagsStatusPairs.begin();it!=this->TimesFlagsStatusPairs.end() && !found;it++)
124 found=(*it).first==name;
126 this->TimesFlagsStatusPairs.push_back(std::pair<std::string,int>(name,status));
129 void PropertyKeeper::pushGenerateVectorsValue(int value)
131 this->IsGVActivated=true;
135 void PropertyKeeper::pushChangeModeValue(int value)
137 this->IsCMActivated=true;
141 bool PropertyKeeper::arePropertiesOnTreeToSetAfter() const
143 return !SetFieldsStatusPairs.empty();
146 class vtkMEDReader::vtkMEDReaderInternal
150 vtkMEDReaderInternal(vtkMEDReader *master):TK(0),IsMEDOrSauv(true),IsStdOrMode(false),GenerateVect(false),SIL(0),LastLev0(-1),FirstCall0(2),PK(master)
162 ~vtkMEDReaderInternal()
168 MEDFileFieldRepresentationTree Tree;
170 std::string FileName;
171 //when true the file is MED file. when false it is a Sauv file
173 //when false -> std, true -> mode. By default std (false).
175 //when false -> do nothing. When true cut off or extend to nbOfCompo=3 vector arrays.
177 std::string DftMeshName;
178 // Store the vtkMutableDirectedGraph that represents links between family, groups and cell types
179 vtkMutableDirectedGraph* SIL;
180 // store the lev0 id in Tree corresponding to the TIME_STEPS in the pipeline.
182 // The property keeper is usable only in pvsm mode.
185 unsigned char FirstCall0;
188 vtkStandardNewMacro(vtkMEDReader);
190 vtkMEDReader::vtkMEDReader():Internal(new vtkMEDReaderInternal(this))
192 this->SetNumberOfInputPorts(0);
193 this->SetNumberOfOutputPorts(1);
196 vtkMEDReader::~vtkMEDReader()
198 delete this->Internal;
201 void vtkMEDReader::Reload(int a)
205 std::cerr << "vtkMEDReader::Reload" << a << std::endl;
206 std::string fName((const char *)this->GetFileName());
207 delete this->Internal;
208 this->Internal=new vtkMEDReaderInternal(this);
209 this->SetFileName(fName.c_str());
212 void vtkMEDReader::GenerateVectors(int val)
214 if(this->Internal->FileName.empty())
216 this->Internal->PK.pushGenerateVectorsValue(val);
219 //not pvsm mode (general case)
220 bool val2((bool)val);
221 if(val2!=this->Internal->GenerateVect)
223 this->Internal->GenerateVect=val2;
228 void vtkMEDReader::ChangeMode(int newMode)
230 if(this->Internal->FileName.empty())
232 this->Internal->PK.pushChangeModeValue(newMode);
235 //not pvsm mode (general case)
236 this->Internal->IsStdOrMode=newMode!=0;
237 //std::cerr << "vtkMEDReader::ChangeMode : " << this->Internal->IsStdOrMode << std::endl;
241 const char *vtkMEDReader::GetSeparator()
243 return MEDFileFieldRepresentationLeavesArrays::ZE_SEP;
246 void vtkMEDReader::SetFileName(const char *fname)
250 this->Internal->FileName=fname;
251 std::size_t pos(this->Internal->FileName.find_last_of('.'));
252 if(pos!=std::string::npos)
254 std::string ext(this->Internal->FileName.substr(pos));
255 if(ext.find("sauv")!=std::string::npos)
256 this->Internal->IsMEDOrSauv=false;
258 if(this->Internal->Tree.getNumberOfLeavesArrays()==0)
260 this->Internal->Tree.loadMainStructureOfFile(this->Internal->FileName.c_str(),this->Internal->IsMEDOrSauv);
261 if(!this->Internal->PK.arePropertiesOnTreeToSetAfter())
262 this->Internal->Tree.activateTheFirst();//This line manually initialize the status of server (this) with the remote client.
263 this->Internal->TK.setMaxNumberOfTimeSteps(this->Internal->Tree.getMaxNumberOfTimeSteps());
266 this->Internal->PK.assignPropertiesIfNeeded();
268 catch(INTERP_KERNEL::Exception& e)
270 delete this->Internal;
272 std::ostringstream oss;
273 oss << "Exception has been thrown in vtkMEDReader::SetFileName : " << e.what() << std::endl;
274 if(this->HasObserver("ErrorEvent") )
275 this->InvokeEvent("ErrorEvent",const_cast<char *>(oss.str().c_str()));
277 vtkOutputWindowDisplayErrorText(const_cast<char *>(oss.str().c_str()));
278 vtkObject::BreakOnError();
282 char *vtkMEDReader::GetFileName()
284 return const_cast<char *>(this->Internal->FileName.c_str());
287 int vtkMEDReader::RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
289 //std::cerr << "########################################## RequestInformation ##########################################" << std::endl;
294 vtkInformation *outInfo(outputVector->GetInformationObject(0));
295 //outInfo->Set(vtkStreamingDemandDrivenPipeline::MAXIMUM_NUMBER_OF_PIECES(),-1);
296 outInfo->Set(vtkDataObject::DATA_TYPE_NAME(),"vtkMultiBlockDataSet");
297 this->UpdateSIL(outInfo);
300 this->PublishTimeStepsIfNeeded(outInfo,dummy);
302 catch(INTERP_KERNEL::Exception& e)
304 std::cerr << "Exception has been thrown in vtkMEDReader::RequestInformation : " << e.what() << std::endl;
310 int vtkMEDReader::RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
312 //std::cerr << "########################################## RequestData ##########################################";
317 vtkInformation *outInfo(outputVector->GetInformationObject(0));
318 vtkMultiBlockDataSet *output(vtkMultiBlockDataSet::SafeDownCast(outInfo->Get(vtkDataObject::DATA_OBJECT())));
319 bool isUpdated(false);
321 if(outInfo->Has(vtkStreamingDemandDrivenPipeline::UPDATE_TIME_STEP()))
322 reqTS=outInfo->Get(vtkStreamingDemandDrivenPipeline::UPDATE_TIME_STEP());
323 //std::cerr << reqTS << std::endl;
324 this->FillMultiBlockDataSetInstance(output,reqTS);
325 output->GetInformation()->Set(vtkDataObject::DATA_TIME_STEP(),reqTS);
326 this->UpdateSIL(outInfo);
327 //this->UpdateProgress((float) progress/((float) maxprogress-1));
329 catch(INTERP_KERNEL::Exception& e)
331 std::cerr << "Exception has been thrown in vtkMEDReader::RequestData : " << e.what() << std::endl;
337 void vtkMEDReader::SetFieldsStatus(const char* name, int status)
339 //std::cerr << "vtkMEDReader::SetFieldsStatus(" << name << "," << status << ") called !" << std::endl;
340 if(this->Internal->FileName.empty())
342 this->Internal->PK.pushFieldStatusEntry(name,status);
345 //not pvsm mode (general case)
348 this->Internal->Tree.changeStatusOfAndUpdateToHaveCoherentVTKDataSet(this->Internal->Tree.getIdHavingZeName(name),status);
349 if(std::string(name)==GetFieldsTreeArrayName(GetNumberOfFieldsTreeArrays()-1))
350 if(!this->Internal->PluginStart0())
353 catch(INTERP_KERNEL::Exception& e)
355 if(!this->Internal->FileName.empty())
357 std::cerr << "vtkMEDReader::SetFieldsStatus error : " << e.what() << " *** WITH STATUS=" << status << endl;
363 int vtkMEDReader::GetNumberOfFieldsTreeArrays()
367 int ret(this->Internal->Tree.getNumberOfLeavesArrays());
368 //std::cerr << "vtkMEDReader::GetNumberOfFieldsTreeArrays called ! " << ret << std::endl;
372 const char *vtkMEDReader::GetFieldsTreeArrayName(int index)
374 return this->Internal->Tree.getNameOfC(index);
375 //std::cerr << "vtkMEDReader::GetFieldsTreeArrayName(" << index << ") called ! " << ret << std::endl;
378 int vtkMEDReader::GetFieldsTreeArrayStatus(const char *name)
380 int zeId(this->Internal->Tree.getIdHavingZeName(name));
381 int ret(this->Internal->Tree.getStatusOf(zeId));
385 void vtkMEDReader::SetTimesFlagsStatus(const char *name, int status)
387 if(this->Internal->FileName.empty())
389 this->Internal->PK.pushTimesFlagsStatusEntry(name,status);
392 //not pvsm mode (general case)
394 std::istringstream iss(name); iss >> pos;
395 this->Internal->TK.getTimesFlagArray()[pos].first=(bool)status;
396 if(pos==this->Internal->TK.getTimesFlagArray().size()-1)
397 if(!this->Internal->PluginStart0())
400 //this->Internal->TK.printSelf(std::cerr);
404 int vtkMEDReader::GetNumberOfTimesFlagsArrays()
408 return (int)this->Internal->TK.getTimesFlagArray().size();
411 const char *vtkMEDReader::GetTimesFlagsArrayName(int index)
413 return this->Internal->TK.getTimesFlagArray()[index].second.c_str();
416 int vtkMEDReader::GetTimesFlagsArrayStatus(const char *name)
419 std::istringstream iss(name); iss >> pos;
420 return (int)this->Internal->TK.getTimesFlagArray()[pos].first;
423 void vtkMEDReader::UpdateSIL(vtkInformation *info)
427 vtkMutableDirectedGraph *sil(vtkMutableDirectedGraph::New());
428 std::string meshName(this->BuildSIL(sil));
429 if(meshName!=this->Internal->DftMeshName)
431 if(this->Internal->SIL)
432 this->Internal->SIL->Delete();
433 this->Internal->SIL=sil;
434 this->Internal->DftMeshName=meshName;
435 info->Set(vtkDataObject::SIL(),this->Internal->SIL);
436 //request->AppendUnique(vtkExecutive::KEYS_TO_COPY(),vtkDataObject::SIL());
445 * The returned string is the name of the mesh activated which groups and families are in \a sil.
447 std::string vtkMEDReader::BuildSIL(vtkMutableDirectedGraph* sil)
450 vtkSmartPointer<vtkVariantArray> childEdge(vtkSmartPointer<vtkVariantArray>::New());
451 childEdge->InsertNextValue(0);
452 vtkSmartPointer<vtkVariantArray> crossEdge(vtkSmartPointer<vtkVariantArray>::New());
453 crossEdge->InsertNextValue(1);
454 // CrossEdge is an edge linking hierarchies.
455 vtkUnsignedCharArray* crossEdgesArray=vtkUnsignedCharArray::New();
456 crossEdgesArray->SetName("CrossEdges");
457 sil->GetEdgeData()->AddArray(crossEdgesArray);
458 crossEdgesArray->Delete();
459 std::vector<std::string> names;
460 // Now build the hierarchy.
461 vtkIdType rootId=sil->AddVertex();
462 names.push_back("SIL");
463 // Add global fields root
464 vtkIdType fieldsRoot(sil->AddChild(rootId,childEdge));
465 names.push_back("FieldsStatusTree");
466 this->Internal->Tree.feedSIL(sil,fieldsRoot,childEdge,names);
467 vtkIdType meshesFamsGrpsRoot(sil->AddChild(rootId,childEdge));
468 names.push_back("MeshesFamsGrps");
469 std::string dftMeshName(this->Internal->Tree.feedSILForFamsAndGrps(sil,meshesFamsGrpsRoot,childEdge,names));
470 // This array is used to assign names to nodes.
471 vtkStringArray *namesArray(vtkStringArray::New());
472 namesArray->SetName("Names");
473 namesArray->SetNumberOfTuples(sil->GetNumberOfVertices());
474 sil->GetVertexData()->AddArray(namesArray);
475 namesArray->Delete();
476 std::vector<std::string>::const_iterator iter;
478 for(cc=0, iter=names.begin(); iter!=names.end(); ++iter, ++cc)
479 namesArray->SetValue(cc,(*iter).c_str());
483 double vtkMEDReader::PublishTimeStepsIfNeeded(vtkInformation *outInfo, bool& isUpdated)
486 std::vector<double> tsteps;
487 if(!this->Internal->IsStdOrMode)
488 tsteps=this->Internal->Tree.getTimeSteps(lev0,this->Internal->TK);
490 { tsteps.resize(1); tsteps[0]=0.; }
492 if(lev0!=this->Internal->LastLev0)
496 timeRange[0]=tsteps.front();
497 timeRange[1]=tsteps.back();
498 outInfo->Set(vtkStreamingDemandDrivenPipeline::TIME_STEPS(),&tsteps[0],tsteps.size());
499 outInfo->Set(vtkStreamingDemandDrivenPipeline::TIME_RANGE(),timeRange,2);
500 this->Internal->LastLev0=lev0;
502 return tsteps.front();
505 void vtkMEDReader::FillMultiBlockDataSetInstance(vtkMultiBlockDataSet *output, double reqTS)
507 std::string meshName;
508 vtkDataSet *ret(this->Internal->Tree.buildVTKInstance(this->Internal->IsStdOrMode,reqTS,meshName,this->Internal->TK));
509 if(this->Internal->GenerateVect)
511 vtkGenerateVectors::Operate(ret->GetPointData());
512 vtkGenerateVectors::Operate(ret->GetCellData());
513 vtkGenerateVectors::Operate(ret->GetFieldData());
515 output->SetBlock(0,ret);
519 void vtkMEDReader::PrintSelf(ostream& os, vtkIndent indent)
521 this->Superclass::PrintSelf(os, indent);