donotcompute.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 DONOTCOMPUTE_H
#define DONOTCOMPUTE_H
 
#include <vector>
#include "../definitions.h"
#include "../readparameters.h"
#include "../spatial_cells/spatial_cell_wrapper.hpp"
#include "sysboundarycondition.h"
 
using namespace projects;
 
namespace SBC {
   class DoNotCompute: public SysBoundaryCondition {
   public:
      DoNotCompute();
      virtual ~DoNotCompute();
 
      static void addParameters();
      virtual void getParameters() override;
 
      void initSysBoundary(creal& t, Project& project) override;
      void assignSysBoundary(dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
                             fsgrids::technicalspan technical, FieldSolverGrid& fsgrid) override;
      void applyInitialState(dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
                             fsgrids::technicalspan technical, FieldSolverGrid& fsgrid,
                             fsgrids::perbspan perb,
                             fsgrids::bgbspan bgb, Project& project) override;
      void updateState(dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
                       fsgrids::technicalspan technical, FieldSolverGrid& fsgrid,
                       fsgrids::perbspan perb,
                       fsgrids::bgbspan bgb, creal t) override;
      void getFaces(bool* faces) override;
      std::string getName() const override;
      uint getIndex() const override;
 
      // Explicit warning functions to inform the user if a doNotCompute cell gets computed
      Real fieldSolverBoundaryCondMagneticField(fsgrids::perbspan,
                                                fsgrids::constbgbspan,
                                                fsgrids::consttechnicalspan, const std::array<Real, 3>&,
                                                const std::array<fsgrid::FsSize_t, 3>&, const fsgrid::FsStencil&,
                                                cuint) override {
         std::cerr << "ERROR: DoNotCompute::fieldSolverBoundaryCondMagneticField called!" << std::endl;
         return 0.;
      }
      void fieldSolverBoundaryCondElectricField(fsgrids::efieldspan,
                                                const fsgrid::FsStencil&, cuint) override {
         std::cerr << "ERROR: DoNotCompute::fieldSolverBoundaryCondElectricField called!" << std::endl;
      }
      void fieldSolverBoundaryCondHallElectricField(fsgrids::ehallspan,
                                                    const fsgrid::FsStencil&, cuint) override {
         std::cerr << "ERROR: DoNotCompute::fieldSolverBoundaryCondHallElectricField called!" << std::endl;
      }
      void fieldSolverBoundaryCondGradPeElectricField(fsgrids::egradpespan,
                                                      const fsgrid::FsStencil&, cuint) override {
         std::cerr << "ERROR: DoNotCompute::fieldSolverBoundaryCondGradPeElectricField called!" << std::endl;
      }
      void fieldSolverBoundaryCondDerivatives(fsgrids::dperbspan,
                                              fsgrids::dmomentsspan,
                                              const fsgrid::FsStencil&, cuint, cuint) override {
         std::cerr << "ERROR: DoNotCompute::fieldSolverBoundaryCondDerivatives called!" << std::endl;
      }
      void fieldSolverBoundaryCondBVOLDerivatives(fsgrids::volspan,
                                                  const fsgrid::FsStencil&, cuint) override {
         std::cerr << "ERROR: DoNotCompute::fieldSolverBoundaryCondBVOLDerivatives called!" << std::endl;
      }
      void vlasovBoundaryCondition(dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>&, const CellID&, const uint,
                                   const bool) override {
         std::cerr << "ERROR: DoNotCompute::vlasovBoundaryCondition called!" << std::endl;
      }
   };
}
 
#endif