validity_check.hpp

Go to the documentation of this file.

#ifndef VALIDITY_CHECK_HPP
#define VALIDITY_CHECK_HPP

#include "grid.hpp"
#include "domain_decomposition.hpp"
#include "plasma.hpp"

namespace ValidityCheck{

// The various ways a particle can be invalid
enum Counts{
    InvalidGID=0,
    InvalidTriangle,
    InvalidRZ,
    InvalidPhi,
    InvalidLocalPhi,
    InvalidLocalNode,
    InvalidMu,
    InvalidW0,
    InvalidParticle,
    N
};

enum ReportingOption{
    AllRanks=0,
    GatherRanks,
    RankZero,
    NoReport
};

struct Options{
    bool checks[Counts::N];
    bool deactivate_invalid;
    ReportingOption reporting;

    Options()
      : deactivate_invalid(false),
        reporting(ReportingOption::AllRanks)
    {
        // By default, run all tests except the GID test (since dead particles aren't generally bad
        for(int i=0; i<Counts::N; i++) checks[i]=true;
        checks[InvalidGID] = false;
    }
};

void particle_validity_check_one_sp(const std::string& label, const Grid<DeviceType> &grid, const MagneticField<DeviceType> &magnetic_field,
                             const DomainDecomposition<DeviceType> &pol_decomp, Species<DeviceType>& species, const Options& options, View<int*, DeviceType>& counts);

void particle_validity_check(const std::string& label, const Grid<DeviceType> &grid, const MagneticField<DeviceType> &magnetic_field,
                             const DomainDecomposition<DeviceType> &pol_decomp, Plasma& plasma, const Options& options);

void plasma_validity_check(const std::string& label, const Grid<DeviceType> &grid, const MagneticField<DeviceType> &magnetic_field,
                           const DomainDecomposition<DeviceType> &pol_decomp, Plasma& plasma, const Options& options);

}

#endif