XdmfGridTemplate.hpp 7.72 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
/*****************************************************************************/
/*                                    XDMF                                   */
/*                       eXtensible Data Model and Format                    */
/*                                                                           */
/*  Id : XdmfTemplate.hpp                                                    */
/*                                                                           */
/*  Author:                                                                  */
/*     Andrew Burns                                                          */
/*     andrew.j.burns2@us.army.mil                                           */
/*     US Army Research Laboratory                                           */
/*     Aberdeen Proving Ground, MD                                           */
/*                                                                           */
/*     Copyright @ 2013 US Army Research Laboratory                          */
/*     All Rights Reserved                                                   */
/*     See Copyright.txt for details                                         */
/*                                                                           */
/*     This software is distributed WITHOUT ANY WARRANTY; without            */
/*     even the implied warranty of MERCHANTABILITY or FITNESS               */
/*     FOR A PARTICULAR PURPOSE.  See the above copyright notice             */
/*     for more information.                                                 */
/*                                                                           */
/*****************************************************************************/

#ifndef XDMFGRIDTEMPLATE_HPP_
#define XDMFGRIDTEMPLATE_HPP_

// C Compatible Includes
#include "Xdmf.hpp"
#include "XdmfItem.hpp"
#include "XdmfGridCollection.hpp"
#include "XdmfItemFactory.hpp"
#include "XdmfTemplate.hpp"
#include "XdmfArray.hpp"
#include "XdmfHeavyDataWriter.hpp"

#ifdef __cplusplus

// Includes

/**
 * @brief Defines a template that can be filled with multiple sets of data.
 *
 * An XdmfTemplate defines a structure. The arrays within that structure
 * are stored if they are not initialized when the structure is first set.
 * Steps can then be added and references to heavy data are produced and
 * stored for later retrieval.
 *
 * This effectively lets an object have several variations with different
 * contained data.
 */
class XDMF_EXPORT XdmfGridTemplate : public XdmfTemplate,
                                     public XdmfGridCollection {

public:

  /**
   * Creates a new instance of the XdmfTemplate object
   *
   * @return    A constructed XdmfTemplate object.
   */
  static shared_ptr<XdmfGridTemplate> New();

  virtual ~XdmfGridTemplate();

  LOKI_DEFINE_VISITABLE(XdmfGridTemplate, XdmfGrid);
  static const std::string ItemTag;

  /**
   * Writes all tracked arrays to heavy data via the provided
   * heavy data writer then stores the heavy data descriptions.
   *
   * @return    The ID of the step that was added
   */
  virtual unsigned int addStep();

  std::map<std::string, std::string> getItemProperties() const;

  std::string getItemTag() const;

  using XdmfGrid::insert;

  // Overriding the parent versions so that all of these reference the Base item
  // instead of the template

  virtual shared_ptr<XdmfArray> getTimes();

  virtual shared_ptr<XdmfGridCollection> getGridCollection(const unsigned int index);

  virtual shared_ptr<const XdmfGridCollection> getGridCollection(const unsigned int index) const;

  virtual shared_ptr<XdmfGridCollection> getGridCollection(const std::string & Name);

  virtual shared_ptr<const XdmfGridCollection> getGridCollection(const std::string & Name) const;

  virtual unsigned int getNumberGridCollections() const;

  virtual void insert(const shared_ptr<XdmfGridCollection> GridCollection);

  virtual void removeGridCollection(const unsigned int index);

  virtual void removeGridCollection(const std::string & Name);

  virtual shared_ptr<XdmfCurvilinearGrid> getCurvilinearGrid(const unsigned int index);

  virtual shared_ptr<const XdmfCurvilinearGrid> getCurvilinearGrid(const unsigned int index) const;

  virtual shared_ptr<XdmfCurvilinearGrid> getCurvilinearGrid(const std::string & Name);

  virtual shared_ptr<const XdmfCurvilinearGrid> getCurvilinearGrid(const std::string & Name) const;

  virtual unsigned int getNumberCurvilinearGrids() const;

  virtual void insert(const shared_ptr<XdmfCurvilinearGrid> CurvilinearGrid);

  virtual void removeCurvilinearGrid(const unsigned int index);

  virtual void removeCurvilinearGrid(const std::string & Name);

  virtual shared_ptr<XdmfRectilinearGrid> getRectilinearGrid(const unsigned int index);

  virtual shared_ptr<const XdmfRectilinearGrid> getRectilinearGrid(const unsigned int index) const;

  virtual shared_ptr<XdmfRectilinearGrid> getRectilinearGrid(const std::string & Name);

  virtual shared_ptr<const XdmfRectilinearGrid> getRectilinearGrid(const std::string & Name) const;

  virtual unsigned int getNumberRectilinearGrids() const;

  virtual void insert(const shared_ptr<XdmfRectilinearGrid> RectilinearGrid);

  virtual void removeRectilinearGrid(const unsigned int index);

  virtual void removeRectilinearGrid(const std::string & Name);

  virtual shared_ptr<XdmfRegularGrid> getRegularGrid(const unsigned int index);

  virtual shared_ptr<const XdmfRegularGrid> getRegularGrid(const unsigned int index) const;

  virtual shared_ptr<XdmfRegularGrid> getRegularGrid(const std::string & Name);

  virtual shared_ptr<const XdmfRegularGrid> getRegularGrid(const std::string & Name) const;

  virtual unsigned int getNumberRegularGrids() const;

  virtual void insert(const shared_ptr<XdmfRegularGrid> RegularGrid);

  virtual void removeRegularGrid(const unsigned int index);

  virtual void removeRegularGrid(const std::string & Name);

  virtual shared_ptr<XdmfUnstructuredGrid> getUnstructuredGrid(const unsigned int index);

  virtual shared_ptr<const XdmfUnstructuredGrid> getUnstructuredGrid(const unsigned int index) const;

  virtual shared_ptr<XdmfUnstructuredGrid> getUnstructuredGrid(const std::string & Name);

  virtual shared_ptr<const XdmfUnstructuredGrid> getUnstructuredGrid(const std::string & Name) const;

  virtual unsigned int getNumberUnstructuredGrids() const;

  virtual void insert(const shared_ptr<XdmfUnstructuredGrid> UnstructuredGrid);

  virtual void removeUnstructuredGrid(const unsigned int index);

  virtual void removeUnstructuredGrid(const std::string & Name);

  /**
   *
   */
  virtual void removeStep(unsigned int stepId);

  virtual void setBase(shared_ptr<XdmfItem> newBase);

  /**
   * Reads in the heavy data associated with the provided step id.
   *
   * @param     stepId  The id of the step whose heavy data
   *                    is to be read in from file
   */
  void setStep(unsigned int stepId);

  void setStep(shared_ptr<XdmfTime> time);

  void traverse(const shared_ptr<XdmfBaseVisitor> visitor);

  XdmfGridTemplate(XdmfGridTemplate &);

protected:

  XdmfGridTemplate();

  virtual void
  populateItem(const std::map<std::string, std::string> & itemProperties,
               const std::vector<shared_ptr<XdmfItem> > & childItems,
               const XdmfCoreReader * const reader);

  shared_ptr<XdmfArray> mTimeCollection;

private:

  XdmfGridTemplate(const XdmfGridTemplate &);  // Not implemented.
  void operator=(const XdmfGridTemplate &);  // Not implemented.

};

#endif

#ifdef __cplusplus
extern "C" {
#endif

// C wrappers go here

struct XDMFGRIDTEMPLATE; // Simply as a typedef to ensure correct typing
typedef struct XDMFGRIDTEMPLATE XDMFGRIDTEMPLATE;

XDMF_ITEM_C_CHILD_DECLARE(XdmfGridTemplate, XDMFGRIDTEMPLATE, XDMF)

#ifdef __cplusplus
}
#endif


#endif /* XDMFGRIDTEMPLATE_HPP_ */