projectTriAxisSearch.h

Go to the documentation of this file.

/*
 * This file is part of Vlasiator.
 * Copyright 2010-2016 Finnish Meteorological Institute
 *
 * For details of usage, see the COPYING file and read the "Rules of the Road"
 * at http://www.physics.helsinki.fi/vlasiator/
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
#ifndef TRIAXISSEARCH_H
#define TRIAXISSEARCH_H
 
#include "project.h"
 
namespace projects {
   class TriAxisSearch: public Project {
   public:
         
   protected:
      virtual uint findBlocksToInitialize(spatial_cell::SpatialCell* cell,const uint popID) const;
 
      /* Evaluates local SpatialCell properties for the project and population,
         then evaluates the phase-space density at the given coordinates.
      */
      virtual Realf probePhaseSpace(spatial_cell::SpatialCell *cell,
                                    const uint popID,
                                    Real vx_in, Real vy_in, Real vz_in) const = 0;

      virtual std::vector<std::array<Real, 3>> getV0(
         creal x,
         creal y,
         creal z,
         const uint popID
         ) const = 0;
   }; // class TriAxisSearch
} // namespace
 
 
#endif