Diagnostics.h

Go to the documentation of this file.

#pragma once
 
 
#include "objects/wrappers/Outcome.h"
#include "quantities/Storage.h"
#include <map>
 
NAMESPACE_SPH_BEGIN
 
struct DiagnosticsError {
    std::string description;
 
    std::map<Size, std::string> offendingParticles;
};
 
using DiagnosticsReport = BasicOutcome<DiagnosticsError>;
 
class IDiagnostic : public Polymorphic {
public:
    virtual DiagnosticsReport check(const Storage& storage, const Statistics& stats) const = 0;
};
 
class ParticlePairingDiagnostic : public IDiagnostic {
private:
    Float radius;
    Float limit;
 
public:
    struct Pair {
        Size i1, i2;
    };
 
    explicit ParticlePairingDiagnostic(const Float radius = 2._f, const Float limit = 1.e-2_f)
        : radius(radius)
        , limit(limit) {}
 
    Array<Pair> getPairs(const Storage& storage) const;
 
    virtual DiagnosticsReport check(const Storage& storage, const Statistics& stats) const override;
};
 
class SmoothingDiscontinuityDiagnostic : public IDiagnostic {
    Float radius;
    Float limit;
 
public:
    SmoothingDiscontinuityDiagnostic(const Float radius, const Float limit = 0.5_f)
        : radius(radius)
        , limit(limit) {}
 
    virtual DiagnosticsReport check(const Storage& storage, const Statistics& stats) const override;
};
 
class CourantInstabilityDiagnostic : public IDiagnostic {
private:
    Float factor;
 
public:
    explicit CourantInstabilityDiagnostic(const Float timescaleFactor);
 
    virtual DiagnosticsReport check(const Storage& storage, const Statistics& stats) const override;
};
 
class OvercoolingDiagnostic : public IDiagnostic {
public:
    virtual DiagnosticsReport check(const Storage& storage, const Statistics& stats) const override;
};
 
NAMESPACE_SPH_END