CORSAIR-109

Changed namespace VLSV to vlsv to be in line with coding style used
elsewhere. Also changed couple classnames.

Mesh types, datatypes, and coordinate systems are now inside nested
namespaces. This prevented some name clashes.

Abovementioned changes had to be made in plugin as well.

Author: sandroos

CHANGELOG

@@ -1,3 +1,17 @@
+*************************************
+***** CHANGES IN REVISION 00401 *****
+*************************************
+
+MINOR
+
+Changed namespace VLSV to vlsv to be in line with coding style used
+elsewhere. Also changed couple classnames.
+
+Mesh types, datatypes, and coordinate systems are now inside nested
+namespaces. This prevented some name clashes.
+
+Abovementioned changes had to be made in plugin as well.
+
 *************************************
 ***** CHANGES IN REVISION 00386 *****
 *************************************

Makefile

@@ -36,10 +36,10 @@ DEPS_VLSVCOMMON = vlsv_common.h vlsv_common.cpp
 DEPS_VLSVCOMMON_MPI = ${DEPS_VLSVCOMMON} vlsv_common_mpi.h vlsv_common_mpi.cpp
 DEPS_READER = ${DEPS_VLSVCOMMON} vlsv_reader.h vlsv_reader.cpp
 DEPR_PARAREADER = ${DEPS_READER} vlsv_reader_parallel.h vlsv_reader_parallel.cpp
-DEPS_WRITER = ${DEPS_VLSVCOMMON} vlsvwriter.h vlsvwriter2.cpp
+DEPS_WRITER = ${DEPS_VLSVCOMMON} vlsv_writer.h vlsv_writer.cpp
 DEPS_VLSV2SILO = vlsv_reader.o muxml.o vlsv_common.o vlsv2silo.cpp
 
-OBJS=multi_io_unit.o muxml.o vlsv_common.o vlsv_common_mpi.o vlsv_reader.o vlsv_reader_parallel.o vlsvwriter.o
+OBJS=multi_io_unit.o muxml.o vlsv_common.o vlsv_common_mpi.o vlsv_reader.o vlsv_reader_parallel.o vlsv_writer.o
 
 # Build rules
 
@@ -64,8 +64,8 @@ vlsv_reader.o: ${DEPS_READER}
 vlsv_reader_parallel.o: ${DEPS_PARAREADER}
 	${CMP} ${CXXFLAGS} ${FLAGS} -o vlsv_reader_parallel.o -c vlsv_reader_parallel.cpp
 
-vlsvwriter.o: ${DEPS_WRITER}
-	${CMP} ${CXXFLAGS} ${FLAGS} -o vlsvwriter.o -c vlsvwriter2.cpp
+vlsv_writer.o: ${DEPS_WRITER}
+	${CMP} ${CXXFLAGS} ${FLAGS} -o vlsv_writer.o -c vlsv_writer.cpp
 
 vlsv2silo: ${DEPS_VLSV2SILO}
 	${CMP} ${CXXFLAGS} ${FLAGS} -o vlsv2silo vlsv2silo.cpp ${INC_SILO} -L${CURDIR} -lvlsv ${LIB_SILO}

multi_io_unit.cpp

@@ -1,6 +1,6 @@
 /** This file is part of VLSV file format.
  * 
- *  Copyright 2011, 2012 Finnish Meteorological Institute
+ *  Copyright 2011-2013 Finnish Meteorological Institute
  *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU Lesser General Public License as published by
@@ -23,15 +23,17 @@
 
 using namespace std;
 
-/** Constructor for struct Multi_IO_Unit.
- * NOTE: MPI datatypes passed to Multi_IO_Unit are not committed or freed, 
- * thus one should only use native MPI datatypes, e.g. as returned by 
- * getMPIDatatype function.
- * @param array In VLSVWriter this is a pointer to array whose contents are
- * written to file. In VLSVParReader this is a pointer to array where data 
- * from file is to be read.
- * @param mpiType MPI datatype defining the I/O operation.
- * @param amount Amount of data to be written or read, in units of mpiType.*/
-VLSV::Multi_IO_Unit::Multi_IO_Unit(char* array,const MPI_Datatype& mpiType,const uint64_t& amount): array(array),mpiType(mpiType),amount(amount) { }
-
+namespace vlsv {
 
+   /** Constructor for struct Multi_IO_Unit.
+    * NOTE: MPI datatypes passed to Multi_IO_Unit are not committed or freed, 
+    * thus one should only use native MPI datatypes, e.g. as returned by 
+    * getMPIDatatype function.
+    * @param array In vlsv::Writer this is a pointer to array whose contents are
+    * written to file. In vlsv::ParallelReader this is a pointer to array where data 
+    * from file is to be read.
+    * @param mpiType MPI datatype defining the I/O operation.
+    * @param amount Amount of data to be written or read, in units of mpiType.*/
+   Multi_IO_Unit::Multi_IO_Unit(char* array,const MPI_Datatype& mpiType,const uint64_t& amount): array(array),mpiType(mpiType),amount(amount) { }
+   
+} // namespace vlsv

multi_io_unit.h

@@ -1,6 +1,6 @@
 /** This file is part of VLSV file format.
  * 
- *  Copyright 2011, 2012 Finnish Meteorological Institute
+ *  Copyright 2011-2013 Finnish Meteorological Institute
  *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU Lesser General Public License as published by
@@ -22,7 +22,7 @@
 #include <stdint.h>
 #include <mpi.h>
 
-namespace VLSV {
+namespace vlsv {
    /** Definition of a parallel file I/O unit. Processes can 
     * define zero or more file action units for a collective file I/O
     * operation in VLSVWriter and VLSVParReader. Those classes will then 

visit-plugin/avtVlsvFileFormat.C

@@ -118,7 +118,7 @@ avtVlsvFileFormat::avtVlsvFileFormat(const char *filename): avtSTMDFileFormat(&f
 
    // INITIALIZE DATA MEMBERS
    inputFile = filename;
-   vlsv = NULL;
+   vlsvReader = NULL;
 
    /*
    // TEST
@@ -167,7 +167,7 @@ void avtVlsvFileFormat::FreeUpResources(void) {
    debug3 << "VLSV\t object " << objectNumber << " / " << objectCounter << endl;
 
    // Delete VLSVReader:
-   delete vlsv; vlsv = NULL;
+   delete vlsvReader; vlsvReader = NULL;
    dataTime = INVALID_TIME;
    dataTimeFound = false;
    dataTimestep = INVALID_CYCLE;
@@ -256,12 +256,12 @@ void avtVlsvFileFormat::PopulateDatabaseMetaData(avtDatabaseMetaData* md) {
 
    // ActivateTimeStep should get called prior to this function.
    // Check that a VLSV file is open:
-   if (vlsv == NULL) {
+   if (vlsvReader == NULL) {
       debug2 << "VLSV\t VLSVReader in NULL, calling ActivateTimestep()." << endl;
       ActivateTimestep();
    }
    string dummy;
-   if (vlsv->getFileName(dummy) == false) {
+   if (vlsvReader->getFileName(dummy) == false) {
       debug2 << "VLSV\t ERROR: Input file has not been opened." << endl;
       return;
    }
@@ -428,7 +428,7 @@ void avtVlsvFileFormat::ActivateTimestep(void) {
    debug3 << "VLSV\t object " << objectNumber << " / " << objectCounter << endl;
 
    // Delete old VLSVReader:
-   delete vlsv; vlsv = NULL;
+   delete vlsvReader; vlsvReader = NULL;
 
    /*
    // TEST
@@ -440,11 +440,11 @@ void avtVlsvFileFormat::ActivateTimestep(void) {
    */
 
    // Create new VLSVReader and open given file:
-   vlsv = new VLSVReader;
-   if (vlsv->open(inputFile) == false) {
+   vlsvReader = new vlsv::Reader;
+   if (vlsvReader->open(inputFile) == false) {
       debug2 << "VLSV\t ERROR: VLSVReader failed to open input file '" << inputFile << "'" << endl;
-      vlsv->close();
-      delete vlsv; vlsv = NULL;
+      vlsvReader->close();
+      delete vlsvReader; vlsvReader = NULL;
       EXCEPTION1(InvalidDBTypeException,"VLSV Plugin could not open the file.");
       return;
    }
@@ -453,8 +453,8 @@ void avtVlsvFileFormat::ActivateTimestep(void) {
    if (metadataRead == false) {
       if (readMetadata() == false) {
 	 debug2 << "VLSV\t ERROR: Failed to read metadata" << endl;
-	 vlsv->close();
-	 delete vlsv; vlsv = NULL;
+	 vlsvReader->close();
+	 delete vlsvReader; vlsvReader = NULL;
 	 EXCEPTION1(InvalidDBTypeException,"VLSV Plugin could not open the file.");
 	 return;
       }
@@ -484,7 +484,7 @@ vtkDataSet* avtVlsvFileFormat::GetMesh(int domain,const char *meshname) {
    debug3 << "VLSV\t object " << objectNumber << " / " << objectCounter << endl;
 
    // Check that VLSVReader exists:
-   if (vlsv == NULL) {
+   if (vlsvReader == NULL) {
       debug1 << "VLSV\t ERROR: VLSVReader is NULL" << endl;
       EXCEPTION1(InvalidVariableException, meshname);
       return NULL;
@@ -515,7 +515,7 @@ vtkDataSet* avtVlsvFileFormat::GetMesh(int domain,const char *meshname) {
 
    // Read mesh coordinates:
    void* meshOut = NULL;
-   if (reader->second->readMesh(vlsv,metadata->second,domain,meshOut) == false) {
+   if (reader->second->readMesh(vlsvReader,metadata->second,domain,meshOut) == false) {
       debug2 << "VLSV\t ERROR: Mesh reader failed to generate mesh" << endl;
    }
 
@@ -548,7 +548,7 @@ bool avtVlsvFileFormat::PrepareVariable(int domain,const char* varName,
    meshReader = meshReaders.end();
 
    // Check that VLSVReader exists:
-   if (vlsv == NULL) {
+   if (vlsvReader == NULL) {
       debug1 << "VLSV\t ERROR: VLSVReader is NULL" << endl;
       return false;
    }
@@ -639,7 +639,7 @@ vtkDataArray* avtVlsvFileFormat::ReadVariable(int domain,const char* varName) {
       return NULL;
    }
 
-   if (meshReader->second->readVariable(vlsv,metadata->second,*variableMetadata,domain,variablePointer) == false) {
+   if (meshReader->second->readVariable(vlsvReader,metadata->second,*variableMetadata,domain,variablePointer) == false) {
       debug1 << "VLSV\t ERROR: Failed to read variable data" << endl;
       rv->Delete();
       return NULL;
@@ -683,14 +683,14 @@ int avtVlsvFileFormat::GetCycle(void) {
    debug3 << "VLSV\t object " << objectNumber << " / " << objectCounter << endl;
 
    // Check that VLSVReader is not NULL:
-   if (vlsv == NULL) {
+   if (vlsvReader == NULL) {
       debug1 << "VLSV\t ERROR: VLSVReader is NULL." << endl;
       return INVALID_CYCLE;
    }
 
    // Read simulation timestep:
    dataTimestepFound = true;
-   if (vlsv->readParameter("timestep",dataTimestep) == false) {
+   if (vlsvReader->readParameter("timestep",dataTimestep) == false) {
       dataTimestep = INVALID_CYCLE;
       dataTimestepFound = false;
    }
@@ -705,14 +705,14 @@ double avtVlsvFileFormat::GetTime(void) {
    debug3 << "VLSV\t object " << objectNumber << " / " << objectCounter << endl;
 
    // Check that VLSVReader is not NULL:
-   if (vlsv == NULL) {
+   if (vlsvReader == NULL) {
       debug1 << "VLSV\t ERROR: VLSVReader is NULL." << endl;
       return INVALID_TIME;
    }
 
    // Read simulation time:
    dataTimeFound = true;
-   if (vlsv->readParameter("time",dataTime) == false) {
+   if (vlsvReader->readParameter("time",dataTime) == false) {
       dataTime = INVALID_TIME;
       dataTimeFound = false;
    }
@@ -736,13 +736,13 @@ bool avtVlsvFileFormat::readMetadata() {
    metadataRead = false;
 
    // Check that VLSVReader exists:
-   if (vlsv == NULL) {
+   if (vlsvReader == NULL) {
       return false;
    }
 
    // Read mesh names:
    set<string> meshNames;
-   if (vlsv->getUniqueAttributeValues("MESH","name",meshNames) == false) {
+   if (vlsvReader->getUniqueAttributeValues("MESH","name",meshNames) == false) {
       return false;
    }
 
@@ -754,17 +754,17 @@ bool avtVlsvFileFormat::readMetadata() {
       map<string,string> attribsOut;
       list<pair<string,string> > attribsIn;
       attribsIn.push_back(make_pair("name",*it));
-      vlsv->getArrayAttributes("MESH",attribsIn,attribsOut);
+      vlsvReader->getArrayAttributes("MESH",attribsIn,attribsOut);
       if (attribsOut.find("type") == attribsOut.end()) {
 	 debug4 << "VLSV\t skipping it because its type is unspecified" << endl;
 	 continue;
       }
 
       // Check if mesh type corresponds to one of types supported by VisIt:
       bool supportedType = true;
-      if (attribsOut["type"] == VLSV::MESH_POINT) {
+      if (attribsOut["type"] == vlsv::mesh::STRING_POINT) {
 	 vlsvplugin::VisitPointMeshMetadata* pointMesh = new vlsvplugin::VisitPointMeshMetadata();
-	 if (pointMesh->read(vlsv,attribsOut) == false) {
+	 if (pointMesh->read(vlsvReader,attribsOut) == false) {
 	    debug2 << "VLSV\t\t Failed to read point mesh metadata" << endl;
 	    delete pointMesh; pointMesh = NULL;
 	 } else {
@@ -782,9 +782,9 @@ bool avtVlsvFileFormat::readMetadata() {
 	       meshMetadata.erase(tmp);
 	    }
 	 }
-      } else if (attribsOut["type"] == VLSV::MESH_QUAD_MULTI) {
+      } else if (attribsOut["type"] == vlsv::mesh::STRING_QUAD_MULTI) {
 	 vlsvplugin::VisitQuadMultiMeshMetadata* multiMesh = new vlsvplugin::VisitQuadMultiMeshMetadata();
-	 if (multiMesh->read(vlsv,attribsOut) == false) {
+	 if (multiMesh->read(vlsvReader,attribsOut) == false) {
 	    debug2 << "VLSV\t\t Failed to read multimesh metadata" << endl;
 	    delete multiMesh; multiMesh = NULL;
 	 } else {
@@ -802,9 +802,9 @@ bool avtVlsvFileFormat::readMetadata() {
 	       meshMetadata.erase(tmp);
 	    }
 	 }
-      } else if (attribsOut["type"] == VLSV::MESH_UCD_MULTI) {
+      } else if (attribsOut["type"] == vlsv::mesh::STRING_UCD_MULTI) {
 	 vlsvplugin::VisitUCDMultiMeshMetadata* multiUCD = new vlsvplugin::VisitUCDMultiMeshMetadata();
-	 if (multiUCD->read(vlsv,attribsOut) == false) {
+	 if (multiUCD->read(vlsvReader,attribsOut) == false) {
 	    debug2 << "VLSV\t\t Failed to read multimesh metadata" << endl;
 	    delete multiUCD; multiUCD = NULL;
 	 } else {

visit-plugin/avtVlsvFileFormat.h

@@ -98,7 +98,7 @@ class avtVlsvFileFormat: public avtSTMDFileFormat {
 
  protected:
    // DATA MEMBERS
-   VLSVReader* vlsv;
+   vlsv::Reader* vlsvReader;
    std::string inputFile;
 
    bool dataTimestepFound;
@@ -110,11 +110,6 @@ class avtVlsvFileFormat: public avtSTMDFileFormat {
    #ifdef PARALLEL
       int mpiRank;         /**< MPI rank of process owning this instance of VLSV plugin.*/
       int mpiProcessCount; /**< Number of MPI processes in VisIt parallel engine.*/
-
-      // TEST
-//      int N_domains;
-//      uint64_t* domainOffsets;
-      // END TEST
    #endif
 
    bool metadataRead;

visit-plugin/mesh_metadata.cpp

@@ -49,7 +49,7 @@ namespace vlsvplugin {
 
    uint64_t MeshMetadata::getDataSize() const {return dataSize;}
 
-   VLSV::datatype MeshMetadata::getDatatype() const {return datatype;}
+   vlsv::datatype::type MeshMetadata::getDatatype() const {return datatype;}
 
    std::string MeshMetadata::getName() const {return name;}
 
@@ -75,9 +75,9 @@ namespace vlsvplugin {
 
    std::string MeshMetadata::getZUnits() const {return zUnits;}
 
-   bool MeshMetadata::read(VLSVReader* vlsv,const std::map<std::string,std::string>& attribs) {
+   bool MeshMetadata::read(vlsv::Reader* vlsvReader,const std::map<std::string,std::string>& attribs) {
       // Check that reader exists:
-      if (vlsv == NULL) return false;
+      if (vlsvReader == NULL) return false;
 
       bool success = true;
       map<string,string>::const_iterator it;
@@ -122,7 +122,7 @@ namespace vlsvplugin {
 	 debug3 << "VLSV\t\t ERROR: XML tag does have attribute 'datatype'" << endl;
 	 success = false;
       } else {
-	 datatype = VLSV::getVLSVDatatype(it->second);
+	 datatype = vlsv::getVLSVDatatype(it->second);
       }
 
       // Get optional mesh parameters:

visit-plugin/mesh_metadata.h

@@ -48,7 +48,7 @@ namespace vlsvplugin {
 
       virtual uint64_t getArraySize() const;
       virtual uint64_t getDataSize() const;
-      virtual VLSV::datatype getDatatype() const;
+      virtual vlsv::datatype::type getDatatype() const;
       virtual std::string getName() const;
       virtual uint64_t getNumberOfGhostCells() const;
       virtual uint64_t getNumberOfGhostCells(int domain) const =0;
@@ -65,13 +65,13 @@ namespace vlsvplugin {
       virtual std::string getYUnits() const;
       virtual std::string getZUnits() const;
 
-      virtual bool read(VLSVReader* vlsv,const std::map<std::string,std::string>& attribs);
+      virtual bool read(vlsv::Reader* vlsv,const std::map<std::string,std::string>& attribs);
 
     protected:
       uint64_t arraySize;
       uint64_t vectorSize;
       uint64_t dataSize;
-      VLSV::datatype datatype;
+      vlsv::datatype::type datatype;
       std::vector<VariableMetadata> variableMetadata;
 
       uint64_t N_ghostCells;      /**< Total number of ghost cells in the mesh, summed over all domains.*/

visit-plugin/mesh_metadata_visit.cpp

@@ -41,8 +41,8 @@ namespace vlsvplugin {
 
    int VisitMeshMetadata::getTopologicalDimension() const {return topologicalDimension;}
 
-   bool VisitMeshMetadata::read(VLSVReader* vlsv,const std::map<std::string,std::string>& attribs) {
-      return MeshMetadata::read(vlsv,attribs);
+   bool VisitMeshMetadata::read(vlsv::Reader* vlsvReader,const std::map<std::string,std::string>& attribs) {
+      return MeshMetadata::read(vlsvReader,attribs);
    }
 
 } // namespace vlsvplugin

visit-plugin/mesh_metadata_visit.h

@@ -37,7 +37,7 @@ namespace vlsvplugin {
       virtual int getSpatialDimension() const;
       virtual int getTopologicalDimension() const;
 
-      virtual bool read(VLSVReader* vlsv,const std::map<std::string,std::string>& attribs);
+      virtual bool read(vlsv::Reader* vlsv,const std::map<std::string,std::string>& attribs);
 
     protected: