---

RealVect.H

Go to the documentation of this file.

/* _______              __
  / ___/ /  ___  __ _  / /  ___
 / /__/ _ \/ _ \/  ' \/ _ \/ _ \
 \___/_//_/\___/_/_/_/_.__/\___/ 
*/
//
// This software is copyright (C) by the Lawrence Berkeley
// National Laboratory.  Permission is granted to reproduce
// this software for non-commercial purposes provided that
// this notice is left intact.
// 
// It is acknowledged that the U.S. Government has rights to
// this software under Contract DE-AC03-765F00098 between
// the U.S.  Department of Energy and the University of
// California.
//
// This software is provided as a professional and academic
// contribution for joint exchange. Thus it is experimental,
// is provided ``as is'', with no warranties of any kind
// whatsoever, no support, no promise of updates, or printed
// documentation. By using this software, you acknowledge
// that the Lawrence Berkeley National Laboratory and
// Regents of the University of California shall have no
// liability with respect to the infringement of other
// copyrights by any part of this software.
//

#ifndef CH_REALVECT_H
#define CH_REALVECT_H

//
// $Id: RealVect.H,v 1.11 2002/06/18 23:09:09 bvs Exp $
//

#include <cstddef>
#include <cstdlib>
#include <cstring>
#include <iostream>




#include "SPACE.H"
#include "Misc.H"
#include "REAL.H"
#include <cassert>


//
//@Man:
//@Memo: An Real Vector in SpaceDim-Dimensional Space
/*@Doc:

  The class RealVect is an implementation of an Real vector in a
  SpaceDim-dimensional space.  
  RealVect values are accessed using the operator[] function, as for a normal
  C++ array.  In addition, the basic arithmetic operators have been overloaded
  to implement scaling and translation operations.
*/

class RealVect
{
public:



  RealVect ();


  RealVect (D_DECL(Real i, Real j, Real k));


  RealVect (const RealVect& rhs);


  RealVect& operator= (const RealVect& rhs);


  Real& operator[] (int i);


  const Real& operator[] (int i) const;




  bool operator== (const RealVect& p) const;


  bool operator!= (const RealVect& p) const;


  RealVect& operator+= (Real s);


  RealVect& operator+= (const RealVect& p);


  RealVect& operator-= (Real s);


  RealVect& operator-= (const RealVect& p);


  RealVect operator- (const RealVect& p) const;


  RealVect operator- (Real s) const;
 

  RealVect& operator*= (Real s);


  RealVect& operator*= (const RealVect& p);


  RealVect operator* (const RealVect& p) const;


  RealVect operator* (Real s) const;


  RealVect& operator/= (Real s);


  RealVect& operator/= (const RealVect& p);


  RealVect operator/ (const RealVect& p) const;


  RealVect operator/ (Real s) const;


  const Real* dataPtr() const;


  friend RealVect BASISREALV(int dir);


  static const RealVect Zero;


  static const RealVect Unit;


  friend RealVect operator+ (Real            s,
                             const RealVect& p);


  friend RealVect operator- (Real            s,
                             const RealVect& p);


  friend RealVect operator* (Real            s,
                             const RealVect& p);

  friend RealVect operator/ (Real            s,
                             const RealVect& p);


  friend RealVect operator+ (const RealVect& s,
                             const RealVect& p);


  friend RealVect operator- (const RealVect& s,
                             const RealVect& p);


  friend RealVect operator* (const RealVect& s,
                             const RealVect& p);

  friend RealVect operator/ (const RealVect& s,
                             const RealVect& p);

  friend class HDF5Handle;

  static size_t io_offset;
private:

  Real vect[SpaceDim];

};

#include "HDF5.H"

template < >
int linearSize(const RealVect& vindex);
  
//VolIndex specialization of linearIn
template < >
void linearIn(RealVect& a_outputT, const void* const inBuf);
  
//VolIndex specialization of linearOut
template < >
void linearOut(void* const a_outBuf, const RealVect& a_inputT); 


#endif /*CH_RealVect_H*/

---