DataFileIF.H

Go to the documentation of this file.

#ifdef CH_LANG_CC
/*
*      _______              __
*     / ___/ /  ___  __ _  / /  ___
*    / /__/ _ \/ _ \/  V \/ _ \/ _ \
*    \___/_//_/\___/_/_/_/_.__/\___/
*    Please refer to Copyright.txt, in Chombo's root directory.
*/
#endif

#ifndef _DATAFILEIF_H_
#define _DATAFILEIF_H_

#include <iostream>
#include <fstream>
using std::istream;
using std::ifstream;

#include "MayDay.H"
#include "RealVect.H"
#include "IntVectSet.H"
#include "FArrayBox.H"
#include "RefCountedPtr.H"

#include "BaseIF.H"

#include "NamespaceHeader.H"


class DataFileIF: public BaseIF
{
public:

  enum DataType {Invalid=-1, ASCII=0, Binary, NUMDATATYPES};


  DataFileIF(const DataFileIF::DataType& a_dataType,
             const Real&                 a_value,
             const bool&                 a_inside);


  DataFileIF(const char* const           a_filename,
             const DataFileIF::DataType& a_dataType,
             const Real&                 a_value,
             const bool&                 a_inside);


  DataFileIF(const DataFileIF::DataType& a_dataType,
             const RealVect&             a_spacing,
             const RealVect&             a_origin,
             const Real&                 a_value,
             const bool&                 a_inside);


  DataFileIF(const char* const           a_filename,
             const DataFileIF::DataType& a_dataType,
             const RealVect&             a_spacing,
             const RealVect&             a_origin,
             const Real&                 a_value,
             const bool&                 a_inside);


  DataFileIF(const DataFileIF::DataType& a_dataType,
             const IntVect&              a_num,
             const RealVect&             a_spacing,
             const RealVect&             a_origin,
             const Real&                 a_value,
             const bool&                 a_inside);


  DataFileIF(const char* const           a_filename,
             const DataFileIF::DataType& a_dataType,
             const IntVect&              a_num,
             const RealVect&             a_spacing,
             const RealVect&             a_origin,
             const Real&                 a_value,
             const bool&                 a_inside);

  DataFileIF(const DataFileIF& a_inputIF);


  DataFileIF(const RefCountedPtr<FArrayBox> a_data,
             const Real&                    a_noDataValue,
             const IntVect&                 a_num,
             const RealVect&                a_spacing,
             const RealVect&                a_origin,
             const Real&                    a_value,
             const bool&                    a_inside);

  virtual ~DataFileIF();


  virtual void GetHeader(IntVect&  a_num,
                         RealVect& a_spacing,
                         RealVect& a_origin) const;


  virtual void GetParams(Real& a_value,
                         bool& a_inside) const;


  virtual void SetParams(const Real& a_value,
                         const bool& a_inside);


  virtual void SetNoDataValue(const Real& a_value);


  virtual Real value(const RealVect& a_point) const;

  virtual BaseIF* newImplicitFunction() const;

protected:
  void OpenFile(ifstream&         a_file,
                const char* const a_filename);

  void CloseFile(ifstream& a_file);

  void ReadMinHeader(IntVect& a_num,
                     istream& a_file);

  void ReadFullHeader(IntVect&  a_num,
                      RealVect& a_spacing,
                      RealVect& a_origin,
                      istream&  a_file);

  RefCountedPtr<FArrayBox> ReadData(Real&                       a_maxValue,
                                    istream&                    a_file,
                                    const DataFileIF::DataType& a_dataType,
                                    const IntVect&              a_num);

  void MakeCorners(void);

  IntVect  m_num;       // number of grid points in each direction
  RealVect m_spacing;   // grid spacing (in physical coordinates)
  RealVect m_origin;    // grid origin (in physical coordinates)

  Real     m_value;     // level set value

  bool     m_inside;    // inside less than flag

  RefCountedPtr<FArrayBox> m_data;        // the data - copies all share this
  Real                     m_noDataValue; // no data value

  IntVectSet m_corners; // corners of a 1x1 box

private:
  DataFileIF()
  {
    MayDay::Error("DataFileIF uses strong construction");
  }

  void operator=(const DataFileIF& a_inputIF)
  {
    MayDay::Error("DataFileIF doesn't allow assignment");
  }
};

#include "NamespaceFooter.H"
#endif

---