evVectorField.h

Go to the documentation of this file.

/*
 *
 * EVITA: Efficient Visualization of Terascale Datasets
 * Copyright (C) 2000-2016  Team Evita
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 * 
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 675 Mass Ave, Cambridge,
 * MA 02139, USA.
 *
 */


#ifndef __evVectorField_h
#define __evVectorField_h


#include "evScalarField.h"
#include "evVector.h"


class evVectorField : public evField<evVector>
{
public:
  evVectorField(void);
  evVectorField(const evAddress &size, const unsigned int vector_dimension);
  virtual ~evVectorField(void)
  { }

  int SetSize(const evAddress &size,
              const unsigned int vector_dimension = 0,
              const bool allocate = 1);
  int Resize(const evAddress &size,
             const unsigned int vector_dimension = 0,
             const bool linear = 0);
  int Copy(const evVectorField &field);

  unsigned int GetVectorDimension(void) const;

  using evField<evVector>::GetField;
  int GetField(evScalarField &field, const unsigned int component) const;

  using evField<evVector>::PutField;
  int PutField(const evScalarField &field, const unsigned int component);

  double GetFieldMax(void) const;
  double GetFieldMin(void) const;
  double GetFieldMaxNorm(void) const;
  double GetFieldMinNorm(void) const;
  evVector GetFieldMean(void) const;
  int GetFieldHighestBitplane(void) const;

  void Scale(const double scale);

protected:

private:
  evVectorField(const evVectorField &vector_field);
};


inline evVectorField::evVectorField(void)
{
}


inline evVectorField::evVectorField(const evAddress &size,
                                    const unsigned int vector_dimension)
{
  this->SetSize(size, vector_dimension);
}


inline unsigned int evVectorField::GetVectorDimension(void) const
{
  if (this->Field.empty())
    return(0);

  return(this->Field[0].Dimension());
}


inline void evVectorField::Scale(const double scale)
{
  for (unsigned int index = 0; index < this->Field.size(); index++)
    this->Field[index] *= scale;
}


#endif