Adding initial Silo writer. Modifying writer interface.

IO/Reader.h

@@ -13,11 +13,15 @@
 namespace IO {
 
 
+//! Get the path to a file
+std::string getPath( const std::string& filename );
+
+
 //! List the timesteps in the given directors (dumps.LBPM)
 std::vector<std::string> readTimesteps( const std::string& filename );
 
 
-//! Read the list of variables for the given timestep
+//! Read the list of mesh databases for the given timestep
 std::vector<IO::MeshDatabase> getMeshList( const std::string& path, const std::string& timestep );
 
 
@@ -26,11 +30,29 @@ std::shared_ptr<IO::Mesh> getMesh( const std::string& path, const std::string& t
     const MeshDatabase& meshDatabase, int domain );
 
 
-//! Read the given mesh domain
+/*!
+ * @brief Read the given variable
+ * @details  This function reads the variable data provided for the current timestep
+ * @param[in] path          The path to the file
+ * @param[in] timestep      The timestep iteration
+ * @param[in] meshDatabase  The mesh database (see getMeshList)
+ * @param[in] domain        The index of the domain we want to read
+ * @param[in] variable      The variable name to read
+ * @return                  Returns the variable data as a linear array
+ */
 std::shared_ptr<IO::Variable> getVariable( const std::string& path, const std::string& timestep, 
     const MeshDatabase& meshDatabase, int domain, const std::string& variable );
 
 
+/*!
+ * @brief Reformat the variable to match the mesh
+ * @details  This function modifies the dimensions of the array to match the mesh
+ * @param[in] mesh          The underlying mesh
+ * @param[in/out] variable  The variable name to read
+ */
+void reformatVariable( const IO::Mesh& mesh, IO::Variable& var );
+
+
 } // IO namespace
 
 #endif