---

Scalar.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 Scalar_H
#define Scalar_H

#ifndef WRAPPER
#include "LevelData.H"
#include "FArrayBox.H"
#include "RefCountedPtr.H"
#endif


class Scalar
{
public:
  Scalar();

  ~Scalar();

  Scalar(const Scalar& scalar); // ref-counted copy.

  void define(const DisjointBoxLayout& dp, const IntVect& ghost, 
                          const Box& domain);

//actual define function that pulls the data off the disk.  not
// used in interpretive interface (interpreter doesn't have HDF5Handle
// object
  int define(HDF5Handle& handle, std::string& group, int component,
                         const IntVect& ghost); 

  ~Scalar();

  void exchange();

  Scalar copy() const; //actual deep copy, not refcopy.

  IntVect ghostVect() const;

  const DisjointBoxLayout& getBoxes() const;

  const DisjointBoxLayout& disjointBoxLayout() const;

  Box box(int index) const  ;

  FArrayBox& get(int index) ;

  int size() const ; //returns the number of FArrayBox objects.

  const LevelData<FArrayBox>* dataPtr() const ;

  int refCount() const;

  bool isNull() const;

  Real norm (int p) const;

  Real min (int& box, IntVect& index) const;

  Real max (int& box, IntVect& index) const;

  void abs ();

  Real sum ();

  void scale (Real v);

  void add (Real v);

  Scalar neg() const ; // return negative of Scalar

  void mult(const Scalar& rhs); // in-place *=

  void plus(const Scalar& rhs); // in place +=

  void call(PyObject *PyFunc); // callback function
  
private:
  RefCountedPtr<LevelData<FArrayBox> > m_ptr;
  Box m_domain;
};

#endif

---