sysboundary.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 SYSBOUNDARY_H
#define SYSBOUNDARY_H
 
#include <map>
#include <list>
#include <vector>
#include <mpi.h>
#include <dccrg.hpp>
#include <dccrg_cartesian_geometry.hpp>
#include "../definitions.h"
#include "../parameters.h"
#include "../readparameters.h"
#include "../spatial_cells/spatial_cell_wrapper.hpp"
 
#include "sysboundarycondition.h"

class SysBoundary {
 public:
   SysBoundary();
   ~SysBoundary();
 
   void addParameters();
   void getParameters();
 
   void addSysBoundary(
                       SBC::SysBoundaryCondition* sbc,
                       Project& project,
                       creal& t
                      );
   void initSysBoundaries(
                          Project& project,
                          creal& t
                         );
   bool existSysBoundary(std::string name);
   void checkRefinement(dccrg::Dccrg<spatial_cell::SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid);
   void classifyCells(dccrg::Dccrg<spatial_cell::SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid,
                     fsgrids::technicalspan technical, FieldSolverGrid &fsgrid);
   void applyInitialState(dccrg::Dccrg<spatial_cell::SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
                          fsgrids::technicalspan technical, FieldSolverGrid &fsgrid,
                          fsgrids::perbspan perb,
                          fsgrids::bgbspan bgb, Project& project);
   void updateState(dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
                    fsgrids::technicalspan technical, FieldSolverGrid &fsgrid,
                    fsgrids::perbspan perb,
                    fsgrids::bgbspan bgb, creal t);
   void applySysBoundaryVlasovConditions(dccrg::Dccrg<spatial_cell::SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid, creal& t, const bool calculate_V_moments);
   void setupL2OutflowAtRestart(dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid);
 
   unsigned int size() const;
   SBC::SysBoundaryCondition* getSysBoundary(cuint sysBoundaryType) const;
   bool isAnyDynamic() const;
   bool isPeriodic(uint direction) const;
   void updateSysBoundariesAfterLoadBalance(dccrg::Dccrg<spatial_cell::SpatialCell, dccrg::Cartesian_Geometry> &mpiGrid);
   void clear() { // Clears all conts of SBC (destructing template cells for GPU branch)
      sysBoundaries.clear();
   }
   private:
      SysBoundary(const SysBoundary& bc);
 
      //std::set<SBC::SysBoundaryCondition*,SBC::Comparator> sysBoundaries;

      std::list<SBC::SysBoundaryCondition*> sysBoundaries;
      std::map<uint, SBC::SysBoundaryCondition*> indexToSysBoundary;
      std::vector<std::string> sysBoundaryCondList;
      bool anyDynamic;

      std::array<bool, 3> periodic;
};
 
bool precedenceSort(const SBC::SysBoundaryCondition* first,
                    const SBC::SysBoundaryCondition* second);
 
 
 
/*
   Input a vector of cellIDs (cellList) and compute a new vector with only those cells which are on a sysboundary and are to be computed
*/
void getBoundaryCellList(const dccrg::Dccrg<spatial_cell::SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid,
                         const std::vector<CellID>& cellList,
                         std::vector<CellID>& boundaryCellList);
 
#endif