grid.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 GRID_H
#define GRID_H
 
#include "definitions.h"
#include "spatial_cells/spatial_cell_wrapper.hpp"
#include "spatial_cells/block_adjust_wrapper.hpp"
#include <dccrg.hpp>
#include <dccrg_cartesian_geometry.hpp>
#include "fsgrid.hpp"
#include "sysboundary/sysboundary.h"
#include "projects/project.h"
#include <string>
 
struct FieldSolverData {
   FieldSolverGrid& fsgrid;
 
   fsgrids::constperbspan perB;
   fsgrids::constperbspan perBDt2;
   fsgrids::constefieldspan E;
   fsgrids::constefieldspan EDt2;
   fsgrids::constehallspan EHall;
   fsgrids::constegradpespan EGradPe;
   fsgrids::constegradpespan EGradPeDt2;
   fsgrids::constmomentsspan moments;
   fsgrids::constmomentsspan momentsDt2;
   fsgrids::constdperbspan dPerB;
   fsgrids::constdmomentsspan dMoments;
   fsgrids::constdmomentsspan dMomentsDt2;
   fsgrids::constbgbspan BgB;
   fsgrids::constvolspan vol;
   fsgrids::consttechnicalspan technical;
 
   FieldSolverData(const fsgrid::FsData<std::array<Real, fsgrids::bfield::N_BFIELD>>& perb,
           const fsgrid::FsData<std::array<Real, fsgrids::bfield::N_BFIELD>>& perbdt2,
           const fsgrid::FsData<std::array<Real, fsgrids::efield::N_EFIELD>>& e,
           const fsgrid::FsData<std::array<Real, fsgrids::efield::N_EFIELD>>& edt2,
           const fsgrid::FsData<std::array<Real, fsgrids::ehall::N_EHALL>>& ehall,
           const fsgrid::FsData<std::array<Real, fsgrids::egradpe::N_EGRADPE>>& egradpe,
           const fsgrid::FsData<std::array<Real, fsgrids::egradpe::N_EGRADPE>>& egradpedt2,
           const fsgrid::FsData<std::array<Real, fsgrids::moments::N_MOMENTS>>& moments,
           const fsgrid::FsData<std::array<Real, fsgrids::moments::N_MOMENTS>>& momentsdt2,
           const fsgrid::FsData<std::array<Real, fsgrids::dperb::N_DPERB>>& dperb,
           const fsgrid::FsData<std::array<Real, fsgrids::dmoments::N_DMOMENTS>>& dmoments,
           const fsgrid::FsData<std::array<Real, fsgrids::dmoments::N_DMOMENTS>>& dmomentsdt2,
           const fsgrid::FsData<std::array<Real, fsgrids::bgbfield::N_BGB>>& bgb,
           const fsgrid::FsData<std::array<Real, fsgrids::volfields::N_VOL>>& vol,
           const fsgrid::FsData<fsgrids::technical>& technical, FieldSolverGrid& fsgrid)
       : fsgrid(fsgrid), perB(perb.view()), perBDt2(perbdt2.view()), E(e.view()), EDt2(edt2.view()),
         EHall(ehall.view()), EGradPe(egradpe.view()), EGradPeDt2(egradpedt2.view()), moments(moments.view()),
         momentsDt2(momentsdt2.view()), dPerB(dperb.view()), dMoments(dmoments.view()), dMomentsDt2(dmomentsdt2.view()),
         BgB(bgb.view()), vol(vol.view()), technical(technical.view()) {}
};

void initializeGrids(int argn, char** argc, dccrg::Dccrg<SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
                     fsgrid::FsData<std::array<Real, fsgrids::bfield::N_BFIELD>>& perb,
                     fsgrid::FsData<std::array<Real, fsgrids::bgbfield::N_BGB>>& bgb,
                     fsgrid::FsData<std::array<Real, fsgrids::moments::N_MOMENTS>>& moments,
                     fsgrid::FsData<std::array<Real, fsgrids::moments::N_MOMENTS>>& momentsdt2,
                     fsgrid::FsData<std::array<Real, fsgrids::dmoments::N_DMOMENTS>>& dmoments,
                     fsgrid::FsData<std::array<Real, fsgrids::efield::N_EFIELD>>& e,
                     fsgrid::FsData<std::array<Real, fsgrids::egradpe::N_EGRADPE>>& egradpe,
                     fsgrid::FsData<std::array<Real, fsgrids::volfields::N_VOL>>& vol,
                     fsgrid::FsData<fsgrids::technical>& technical, FieldSolverGrid& fsgrid,
                     SysBoundary& sysBoundaries, Project& project);

void balanceLoad(dccrg::Dccrg<SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid, SysBoundary& sysBoundaries, fsgrids::technicalspan technical, FieldSolverGrid &fsgrid,
   bool doTranslationLists = true);
 
/* helper for calculating AMR flags and cell lists and building pencils
 */
void prepareAMRLists(dccrg::Dccrg<SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid);
 

void updateRemoteVelocityBlockLists(
   dccrg::Dccrg<SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid,
   const uint popID,
   const uint neighborhood=Neighborhoods::DIST_FUNC
);

void deallocateRemoteCellBlocks(dccrg::Dccrg<SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid);

bool adjustVelocityBlocks(dccrg::Dccrg<SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid,
                          const std::vector<CellID>& cellsToAdjust,
                          bool doPrepareToReceiveBlocks,
                          const uint popID);

void shrink_to_fit_grid_data(dccrg::Dccrg<SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid);
 
void setFaceNeighborRanks( dccrg::Dccrg<SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid );

void mapRefinement(dccrg::Dccrg<SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid, fsgrids::technicalspan technical, FieldSolverGrid &fsgrid);

bool adaptRefinement(dccrg::Dccrg<SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid, fsgrids::technicalspan technical, FieldSolverGrid &fsgrid, SysBoundary& sysBoundaries, Project& project, int useStatic = -1);
 
void recalculateLocalCellsCache(const dccrg::Dccrg<SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid);
 
#endif