inflow.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 INFLOW_H
#define INFLOW_H
 
#include <vector>
#include "../definitions.h"
#include "../readparameters.h"
#include "../spatial_cells/spatial_cell_wrapper.hpp"
#include "sysboundarycondition.h"
 
namespace SBC {
 
struct InflowSpeciesParameters {
   std::vector<std::vector<Real>> inputData[6];
   std::string files[6];

   uint nParams;
};

class Inflow : public OuterBoundaryCondition {
public:
   Inflow();
   virtual ~Inflow();
 
   //virtual void getParameters() = 0;
 
   virtual void initSysBoundary(creal& t, Project& project) override;
   virtual void applyInitialState(dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
                                  fsgrids::technicalspan technical, FieldSolverGrid& fsgrid,
                                  fsgrids::perbspan perb,
                                  fsgrids::bgbspan bgb, Project& project) override;
   virtual void updateState(dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
                            fsgrids::technicalspan technical, FieldSolverGrid& fsgrid,
                            fsgrids::perbspan perb,
                            fsgrids::bgbspan bgb, creal t) override;
   virtual Real fieldSolverBoundaryCondMagneticField(fsgrids::perbspan b,
                                                     fsgrids::constbgbspan bgb,
                                                     fsgrids::consttechnicalspan technical,
                                                     const std::array<Real, 3>& gridSpacing,
                                                     const std::array<fsgrid::FsSize_t, 3>& globalCoordinates,
                                                     const fsgrid::FsStencil& stencil, cuint component) override;
   virtual void fieldSolverBoundaryCondElectricField(fsgrids::efieldspan e,
                                                     const fsgrid::FsStencil& stencil, cuint component) override;
   virtual void fieldSolverBoundaryCondHallElectricField(fsgrids::ehallspan ehall,
                                                         const fsgrid::FsStencil& stencil, cuint component) override;
   virtual void
   fieldSolverBoundaryCondGradPeElectricField(fsgrids::egradpespan EGradPe,
                                              const fsgrid::FsStencil& stencil, cuint component) override;
   virtual void fieldSolverBoundaryCondDerivatives(fsgrids::dperbspan dperb,
                                                   fsgrids::dmomentsspan dmoments,
                                                   const fsgrid::FsStencil& stencil, cuint RKCase,
                                                   cuint component) override;
   virtual void fieldSolverBoundaryCondBVOLDerivatives(fsgrids::volspan vols,
                                                       const fsgrid::FsStencil& stencil, cuint component) override;
   virtual void vlasovBoundaryCondition(dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
                                        const CellID& cellID, const uint popID, const bool doCalcMomentsV) override;
   virtual void getFaces(bool* faces) override;
   virtual std::string getName() const override {
      std::cerr << "ERROR: base class Inflow::getParameters called!" << std::endl;
      return "ERROR";
   }
   virtual uint getIndex() const = 0; // {
   //   std::cerr << "ERROR: base class Inflow::getIndex called!" << std::endl;
   //   return sysboundarytype::N_SYSBOUNDARY_CONDITIONS;
//   }
 
protected:
   spatial_cell::SpatialCell templateCells[6];
   Real templateB[6][3];
   Real tInterval;
   Real tLastApply;
   std::vector<std::string> faceList;
   std::vector<InflowSpeciesParameters> speciesParams;
   std::vector<std::vector<Real>> loadFile(const char* file, unsigned int nParams);
 
   void loadInputData(const uint popID);
   void interpolate(const int inputDataIndex, const uint popID, creal t, Real* outputData);
   void generateTemplateCells(creal t);
   virtual void generateTemplateCell(spatial_cell::SpatialCell& templateCell, Real (&B)[3], int inputDataIndex,
                                     creal t) {
      std::cerr << "ERROR: base class Inflow::generateTemplateCell called!" << std::endl;
   }
   void setCellsFromTemplate(dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid, const uint popID);
   void setBFromTemplate(dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
                         fsgrids::perbspan perb,
                         fsgrids::bgbspan bgb,
                         fsgrids::technicalspan technical,
                         FieldSolverGrid &fsgrid,
                         const bool resetSolved);
};
} // namespace SBC
 
#endif