Cfield.h

/**********************************************************************
 * Copyright (C) 2012, The YaDICs Project Developers. 
 * See the COPYRIGHT file at the top-level directory of this distribution ./COPYRIGHT.
 * See ./COPYING file for copying and redistribution conditions.
 * 
 * This file is part of YaDICs.
 * YaDICs 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 3 of the License, or
 * (at your option) any later version.
 * 
 * YaDICs 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 YaDICs.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * Information about how to use the software are provided at http://yadic.univ-lille1.fr/
 **********************************************************************/


#ifndef CFIELD
#define CFIELD


//-----------------------------CIMG_NETCDF-------------------------------
#define cimg_plugin  "plugins/add_fileformat.h"
#define cimg_use_netcdf

#ifdef cimg_use_netcdf
 #include "../NetCDF.Tool/struct_parameter_NetCDF.h"
// #define     cimg_plugin1 "plugins/netcdf_file_format4CImg1.h"
// #define cimglist_plugin1 "plugins/netcdf_file_format4CImgList1.h"
 #define     cimg_plugin2 "plugins/netcdf_file_format4CImg2.h"
 #define cimglist_plugin2 "plugins/netcdf_file_format4CImgList2.h"
 #include "../CImg.Tool/CImg_NetCDF.h"
#endif
//-----------------------------CIMG_NETCDF-------------------------------

#include "Cimage.h"
#include "Cmesh_factory.h"
#include "CshapeFunction_factory.h"

template<typename T, typename Timg>
class Cfield 
{
  
  public:
      
    std::string class_name;
    std::string m_type;
    std::string m_name;
    
    int num_dim, m_threadNB;
    int _3D;
    bool m_verbose;
    const char* m_paramPath;
    
    //optionnal
    CImgList<T> m_field;
    CImg<T> m_res;
    CImg<T> m_def;
    //store identified eigenvalues
    CImgList<T> m_mode;
    std::vector<T> m_meanRes;

    CImg<T> m_correlogram;  
    int m_storeCorrelo;
    CshapeFunction<T,Timg>* m_pShape;
    std::vector<T> m_ref;
   
    Cfield()
    {// constructor
      
      class_name = "Field : mother";
      
      #pragma omp parallel
      {//total number of thread required for reduction process
        m_threadNB = omp_get_num_threads();
      }
      
    }
    
//     ~Cfield()
//     {// destructor
      /*problem segmentation fault */
//       delete m_pShape;
      
//     }

    virtual void init(CParameterNetCDF &fp) = 0;
    
    virtual void exec(const Cimage<Timg> &oImage, const Cmesh<T,Timg> &oMesh, CImgList<T> &modes_prev, CshapeFunction<T,Timg> &oShape_prev, const std::vector<T> &ref_prev, const CImgList<T> &nodes_prev)
    {// assign this->m_fields, this->m_residue and this->m_def according to previous data and current mesh

      _3D = oMesh._3D;
    
      if (oImage.m_storeDef){m_def.assign(oImage.cur_dim(0), oImage.cur_dim(1), oImage.cur_dim(2), oImage.cur_dim(3), 0);}
      if (oImage.m_storeRes){m_res.assign(oImage.cur_dim(0), oImage.cur_dim(1), oImage.cur_dim(2), oImage.cur_dim(3), 0);}
      if (oImage.m_storeField){m_field.assign(oMesh.num_var(), oImage.cur_dim(0), oImage.cur_dim(1), oImage.cur_dim(2), oImage.cur_dim(3), 0);}
      
      m_meanRes.clear();
      
      if (!modes_prev.is_empty())
      {
        if (this->m_verbose){printf("Data projection\n");}
        project(oMesh, oImage, modes_prev, oShape_prev, ref_prev, nodes_prev, this->m_mode);
      
      }
      else
      {
        if (this->m_verbose){printf("The data are initialized to zero\n");}
      }
      
//       oImage.save_netcdf(this->m_mode,"project",0);

    }
    
    virtual void project(const Cmesh<T,Timg> &oMesh, const Cimage<Timg> &oImage, CImgList<T> &modes_prev, CshapeFunction<T,Timg> &oShape_prev, const std::vector<T> &ref_prev, const CImgList<T> &nodes_prev, CImgList<T> &modes_cur) = 0;


    
    int num_var()
    {// List of components

      return m_mode.size();
      
    }   

    int grid_dims(const int &i)
    {// grid dimensions
    
      switch(i)
      {
        case 0: return m_mode[0].width(); break;
        case 1: return m_mode[0].height(); break;
        case 2: return m_mode[0].depth(); break;
        case 3: return m_mode[0].spectrum(); break;
        default:
        {
          std::cerr<<class_name<<"::"<<__func__<<": error: id="<<i<<" is unknown as CImg dimensions\n"<<std::flush;
          return 0;
        }
      }
    }
   
 
};

#endif