Field3D.h

Go to the documentation of this file.

/*******************************************************************
 *  Copyright (C) 2010 by Federico Marulli and Alfonso Veropalumbo  *
 *  federico.marulli3@unibo.it                                      *
 *                                                                  *
 *  This program is free software; you can redistribute it and/or   *
 *  modify it under the terms of the GNU General Public License as  *
 *  published by the Free Software Foundation; either version 2 of  *
 *  the License, or (at your option) any later version.             *
 *                                                                  *
 *  This program 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 General Public License for more details.                    *
 *                                                                  *
 *  You should have received a copy of the GNU General Public       *
 *  License along with this program; if not, write to the Free      *
 *  Software Foundation, Inc.,                                      *
 *  59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.       *
 *******************************************************************/
 
#ifndef __Field3D__
#define __Field3D__
 
#include "Data.h"
 
 
namespace cbl {
 
  namespace data {
  
    class Field3D {
    
    protected:
 
      int m_nX;
 
      int m_nY;
 
      int m_nZ;
 
      int m_nZF;
    
      int m_nCells;
 
      int m_nCells_Fourier;
 
      double m_deltaX;
 
      double m_deltaY;
 
      double m_deltaZ;
 
      double m_MinX;
 
      double m_MinY;
 
      double m_MinZ;
 
      double m_MaxX;
 
      double m_MaxY;
 
      double m_MaxZ;
 
      double m_Volume;
 
      std::vector<double>  m_X;
 
      std::vector<double>  m_Y;
 
      std::vector<double>  m_Z;
 
      std::vector<double>  m_kX;
 
      std::vector<double>  m_kY;
 
      std::vector<double>  m_kZ;
 
      long int inds_to_index (const int i, const int j, const int k) const { return k+m_nZ*(j+m_nY*i); } 
 
      long int inds_to_index_Fourier (const int i, const int j, const int k) const { return k+m_nZF*(j+m_nY*i); }
 
      
    public:
 
 
      Field3D () = default;
 
      Field3D (const double deltaR, const double minX, const double maxX, const double minY, const double maxY, const double minZ, const double maxZ);
 
      Field3D (const int nx, const int ny, const int nz, const double minX, const double maxX, const double minY, const double maxY, const double minZ, const double maxZ);
 
      virtual ~Field3D () = default;
 
 
 
      
      void set_parameters (const double deltaR, const double minX, const double maxX, const double minY, const double maxY, const double minZ, const double maxZ);
 
      void set_parameters (const int nx, const int ny, const int nz, const double minX, const double maxX, const double minY, const double maxY, const double minZ, const double maxZ);
      
 
 
      
      int nx () const { return m_nX; }
 
      int ny() const {return m_nY;}
 
      int nz () const { return m_nZ; }
 
      int nzFourier () const { return m_nZF; }
    
      int nCells () const { return m_nCells; }
 
      int nCellsFourier () const { return m_nCells_Fourier; }
 
      double MinX () const { return m_MinX; }
 
      double MinY () const { return m_MinY; }
 
      double MinZ () const { return m_MinZ; }
 
      double MaxX () const { return m_MaxX; }
   
      double MaxY() const { return m_MaxY; }
   
      double MaxZ () const { return m_MaxZ; }
   
      double deltaX () const { return m_deltaX; }
    
      double deltaY () const { return m_deltaY; }
    
      double deltaZ () const { return m_deltaZ; }
 
      double Volume () const { return m_Volume; }
 
      double XX(const int i) const { return m_X[i];}
 
      double YY(const int i) const { return m_Y[i];}
 
      double ZZ(const int i) const { return m_Z[i];}
 
      double kX(const int i) const { return m_kX[i];}
 
      double kY(const int i) const { return m_kY[i];}
    
      double kZ(const int i) const { return m_kZ[i];}
      
      virtual double ScalarField (const int i, const int j, const int k) const
      { (void)i; (void)j; (void)k; ErrorCBL("", "Scalarield", "Field3D.h"); return 0; }
 
        
      virtual double ScalarField (const std::vector<double> pos) const
      { (void)pos; ErrorCBL("", "Scalarield", "Field3D.h"); return 0; }
    
      virtual std::vector<double> ScalarField () const
      { ErrorCBL("", "Scalarield", "Field3D.h"); std::vector<double> vv; return vv; }
 
      virtual std::vector<double> VectorField (const int i, const int j, const int k) const
      { (void)i; (void)j; (void)k; ErrorCBL("", "VectorField", "Field3D.h"); return {0}; }
 
      virtual std::vector<double> VectorField (const std::vector<double> pos) const
      { (void)pos; ErrorCBL("", "VectorField", "Field3D.h"); double vv = 0.; return {vv}; }
 
      virtual double ScalarField_FourierSpace_real (const int i, const int j, const int k) const
      { (void)i; (void)j; (void)k; ErrorCBL("", "ScalarField_FourierSpace_real", "Field3D.h"); return 0; }
 
      virtual double ScalarField_FourierSpace_complex (const int i, const int j, const int k) const
      { (void)i; (void)j; (void)k; ErrorCBL("", "ScalarField_FourierSpace_complex", "Field3D.h"); return 0; }
 
      virtual std::vector<double> ScalarField_FourierSpace_real () const
      { ErrorCBL("", "Scalarield_FourierSpace_real", "Field3D.h"); std::vector<double> vv; return vv; }
 
      virtual std::vector<double> ScalarField_FourierSpace_complex () const
      { ErrorCBL("", "Scalarield_FourierSpace_complex", "Field3D.h"); std::vector<double> vv; return vv; }
 
      virtual std::vector<double> VectorField_FourierSpace_real (const int i, const int j, const int k) const
      { (void)i; (void)j; (void)k; ErrorCBL("", "VectorField_FourierSpace_real", "Field3D.h"); return {0}; }
 
      virtual std::vector<double> VectorField_FourierSpace_complex (const int i, const int j, const int k) const
      { (void)i; (void)j; (void)k; ErrorCBL("", "VectorField_FourierSpace_complex", "Field3D.h"); return {0}; }
 
 
 
      
      virtual void FourierTransformField ()
      { ErrorCBL("", "FourierTransformField", "Field3D.h"); }
 
      virtual void FourierAntiTransformField ()
      { ErrorCBL("", "FourierAntiTransformField", "Field3D.h"); }
 
      virtual void GaussianConvolutionField (const double kernel_size)
      { (void)kernel_size; ErrorCBL("", "GaussianConvolutionField", "Field3D.h"); }
 
      virtual void set_ScalarField (const double value, const int i, const int j, const int k, const bool add=0)
      { (void)value; (void)i; (void)j; (void)k; (void)add; ErrorCBL("", "set_ScalarField", "Field3D.h"); }
    
      virtual void set_VectorField (const std::vector<double> value, const int i, const int j, const int k, const bool add=0)
      { (void)value; (void)i; (void)j; (void)k; (void)add; ErrorCBL("", "set_Vectorield", "Field3D.h"); }
 
      virtual void set_ScalarField_FourierSpace_real (const double value, const int i, const int j, const int k, const bool add=0)
      { (void)value; (void)i; (void)j; (void)k; (void)add; ErrorCBL("", "set_ScalarField_FourierSpace_real", "Field3D.h"); }
    
      virtual void set_ScalarField_FourierSpace_complex (const double value, const int i, const int j, const int k, const bool add=0)
      { (void)value; (void)i; (void)j; (void)k; (void)add; ErrorCBL("", "set_ScalarField_FourierSpace_complex", "Field3D.h"); }
 
      virtual void set_VectorField_FourierSpace_real (const std::vector<double> value, const int i, const int j, const int k, const bool add=0)
      { (void)value; (void)i; (void)j; (void)k; (void)add; ErrorCBL("", "set_VectorField_FourierSpace_real", "Field3D.h"); }
 
      virtual void set_VectorField_FourierSpace_complex (const std::vector<double> value, const int i, const int j, const int k, const bool add=0)
      { (void)value; (void)i; (void)j; (void)k; (void)add; ErrorCBL("", "set_VectorField_FourierSpace_complex", "Field3D.h"); }
 
      virtual void reset()
      { ErrorCBL("", "reset", "Field3D.h"); }
 
      
    };
 
    
    // ==================================================================================================================
    // ==================================================================================================================
    // ==================================================================================================================
 
    
    class ScalarField3D : public Field3D {
      
    protected:
 
      double *m_field;
 
      fftw_complex *m_field_FourierSpace;
 
    public:
 
 
      ScalarField3D () = default;
 
      ScalarField3D (const double deltaR, const double minX, const double maxX, const double minY, const double maxY, const double minZ, const double maxZ);
 
      ScalarField3D (const int nx, const int ny, const int nz, const double minX, const double maxX, const double minY, const double maxY, const double minZ, const double maxZ);
      virtual ~ScalarField3D () = default;
 
 
 
      
      void set_ScalarField (const double value, const int i, const int j, const int k, const bool add=0);
 
      void set_ScalarField_FourierSpace_real (const double value, const int i, const int j, const int k, const bool add=0);
 
      void set_ScalarField_FourierSpace_complex (const double value, const int i, const int j, const int k, const bool add=0);
 
 
 
      
      double ScalarField (const int i, const int j, const int k) const;
            
      double ScalarField (const std::vector<double> pos) const;
 
      std::vector<double> ScalarField () const;
 
      double ScalarField_FourierSpace_real (const int i, const int j, const int k) const;
 
      double ScalarField_FourierSpace_complex (const int i, const int j, const int k) const;
       
      
 
 
      void FourierTransformField ();
 
      void FourierAntiTransformField ();
 
      void GaussianConvolutionField (const double kernel_size);
 
      void reset();
 
    };
 
 
    // ==================================================================================================================
    // ==================================================================================================================
    // ==================================================================================================================
 
    
    class VectorField3D : public Field3D{
    protected:
 
      std::vector<double *> m_field;
 
      std::vector<fftw_complex *> m_field_FourierSpace;
 
    public:
 
 
      VectorField3D () = default;
 
      VectorField3D (const double deltaR, const double minX, const double maxX, const double minY, const double maxY, const double minZ, const double maxZ);
 
      VectorField3D (const int nx, const int ny, const int nz, const double minX, const double maxX, const double minY, const double maxY, const double minZ, const double maxZ);
      ~VectorField3D () = default;
 
 
 
      
      void set_VectorField (const std::vector<double> value, const int i, const int j, const int k, const bool add=0);
 
      void set_VectorField_FourierSpace_real (const std::vector<double> value, const int i, const int j, const int k, const bool add=0);
 
      void set_VectorField_FourierSpace_complex (const std::vector<double> value, const int i, const int j, const int k, const bool add=0);
 
 
 
      
      std::vector<double> VectorField (const int i, const int j, const int k) const;
      
      std::vector<double> VectorField (const std::vector<double> pos) const;
 
      std::vector<double> VectorField_FourierSpace_real (const int i, const int j, const int k) const;
 
      std::vector<double> VectorField_FourierSpace_complex (const int i, const int j, const int k) const;
 
 
      
      
      void FourierTransformField ();
 
      void FourierAntiTransformField ();
 
      void reset();
 
 
    };
 
  }
}
 
#endif