outflow.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 OUTFLOW_H
#define OUTFLOW_H
 
#include <vector>
#include "../definitions.h"
#include "../readparameters.h"
#include "../spatial_cells/spatial_cell_wrapper.hpp"
#include "sysboundarycondition.h"
 
namespace SBC {
 
   struct OutflowSpeciesParameters {
         std::array<bool, 6> facesToSkipVlasov;
      std::array<uint, 6> faceVlasovScheme;
      std::vector<std::string> faceToReapplyUponRestartList;

      Real quenchFactor;
   };

   class Outflow: public OuterBoundaryCondition {
   public:
      Outflow();
      virtual ~Outflow();
 
      static void addParameters();
      virtual void getParameters() override;
 
      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 calculate_V_moments
      ) override;
      virtual void setupL2OutflowAtRestart(dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid) override;
 
      virtual void getFaces(bool* faces)  override;
      virtual std::string getName() const override;
      virtual uint getIndex() const override;
 
   protected:
      bool facesToSkipFields[6];
      bool facesToReapply[6];
      std::vector<std::string> faceList;
      std::vector<std::string> faceNoFieldsList;
      std::vector<OutflowSpeciesParameters> speciesParams;

      Real quenchFactor;
 
      enum vlasovscheme {
         NONE,
         COPY,
         N_SCHEMES
      };
   }; // class Outflow
} // namespace SBC
 
#endif