errorcheckingexportmodule.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2025   Borek Patzak
 *
 *
 *
 *       Czech Technical University, Faculty of Civil Engineering,
 *   Department of Structural Mechanics, 166 29 Prague, Czech Republic
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef errorcheckingexportmodule_h_
#define errorcheckingexportmodule_h_
 
#include <vector>
#include <memory>
#include <fstream>
 
#include "exportmodule.h"
#include "valuemodetype.h"
#include "internalstatetype.h"


#define _IFT_ErrorCheckingExportModule_Name "errorcheck"
#define _IFT_ErrorCheckingExportModule_filename "filename" 
#define _IFT_ErrorCheckingExportModule_writeIST "writeist" 
#define _IFT_ErrorCheckingExportModule_extractormode "extract" 
 
namespace oofem {
class Domain;
class Element;
class DofManager;
 

class OOFEM_EXPORT ErrorCheckingRule
{
protected:
    int tstep = 0;
    int tsubstep = 0;
    int number = 0;
    double tolerance = 0.;
    double value = 0.; // expected value
    double computedValue = 0.;
 
public:
    ErrorCheckingRule(double tol) : tolerance(tol) { }
    virtual ~ErrorCheckingRule() = default;

    virtual bool check(Domain *domain, TimeStep *tStep) = 0;
    // returns the computed value (in given solution step) 
    virtual bool getValue(double& value, Domain* domain, TimeStep *tStep)=0;
 
    bool checkValue(double computedValue);
    virtual const char *giveClassName() const = 0;
};

class OOFEM_EXPORT NodeErrorCheckingRule : public ErrorCheckingRule
{
protected:
    int dofid = 0;
    ValueModeType mode = VM_Unknown;
 
public:
    NodeErrorCheckingRule(const std :: string &line, double tol);
    NodeErrorCheckingRule(InputRecord& ir, double tol);
    bool check(Domain *domain, TimeStep *tStep) override;
    bool getValue(double& value, Domain* domain, TimeStep *tStep) override;
    const char *giveClassName() const override { return "NodeErrorCheckingRule"; }
};

class OOFEM_EXPORT ElementErrorCheckingRule : public ErrorCheckingRule
{
protected:
    int irule = 0;
    int gpnum = 0;
    InternalStateType ist = IST_Undefined;
    int component = 0;
 
public:
    ElementErrorCheckingRule(const std :: string &line, double tol);
    ElementErrorCheckingRule(InputRecord& ir, double tol);
    bool check(Domain *domain, TimeStep *tStep) override;
    bool getValue(double& value, Domain* domain, TimeStep *tStep) override;
    const char *giveClassName() const override { return "ElementErrorCheckingRule"; }
};

class OOFEM_EXPORT InternalElementDofManErrorCheckingRule : public ErrorCheckingRule
{
protected:
    int idofman = 0;
    int dofid = 0;
    ValueModeType mode = VM_Unknown;
 
public:
    InternalElementDofManErrorCheckingRule(const std :: string &line, double tol);
    InternalElementDofManErrorCheckingRule(InputRecord& ir, double tol);
    bool check(Domain *domain, TimeStep *tStep) override;
    bool getValue(double& value, Domain* domain, TimeStep *tStep) override;
    const char *giveClassName() const override { return "InternalElementDofManErrorCheckingRule"; }
};

class OOFEM_EXPORT BeamElementErrorCheckingRule : public ErrorCheckingRule
{
public:
    enum BeamElementValueType{
        BET_localEndDisplacement,
        BET_localEndForces
    };
 
protected:
    BeamElementValueType ist = BET_localEndDisplacement;
    int component = 0;
 
public:
    BeamElementErrorCheckingRule(const std :: string &line, double tol);
    BeamElementErrorCheckingRule(InputRecord& ir, double tol);
    bool check(Domain *domain, TimeStep *tStep) override;
    bool getValue(double& value, Domain* domain, TimeStep *tStep) override; 
    const char *giveClassName() const override { return "BeamElementErrorCheckingRule"; }
};
 

class OOFEM_EXPORT ReactionErrorCheckingRule : public ErrorCheckingRule
{
protected:
    int dofid = 0;
 
public:
    ReactionErrorCheckingRule(const std :: string &line, double tol);
    ReactionErrorCheckingRule(InputRecord& ir, double tol);
    bool check(Domain *domain, TimeStep *tStep) override;
    bool getValue(double& value, Domain* domain, TimeStep *tStep) override;
    const char *giveClassName() const override { return "ReactionErrorCheckingRule"; }
};

class OOFEM_EXPORT LoadLevelErrorCheckingRule : public ErrorCheckingRule
{
public:
    LoadLevelErrorCheckingRule(const std :: string &line, double tol);
    LoadLevelErrorCheckingRule(InputRecord& ir, double tol);
    bool check(Domain *domain, TimeStep *tStep) override;
    bool getValue(double& value, Domain* domain, TimeStep *tStep) override;
    const char *giveClassName() const override { return "LoadLevelErrorCheckingRule"; }
};

class OOFEM_EXPORT EigenValueErrorCheckingRule : public ErrorCheckingRule
{
public:
    EigenValueErrorCheckingRule(const std :: string &line, double tol);
    EigenValueErrorCheckingRule(InputRecord& ir, double tol);
    bool check(Domain *domain, TimeStep *tStep) override;
    bool getValue(double& value, Domain* domain, TimeStep *tStep) override;
    const char *giveClassName() const override { return "EigenValueErrorCheckingRule"; }
};

class OOFEM_EXPORT TimeCheckingRule : public ErrorCheckingRule
{
public:
    TimeCheckingRule(const std :: string &line, double tol);
    TimeCheckingRule(InputRecord& ir, double tol);
    bool check(Domain *domain, TimeStep *tStep) override;
    bool getValue(double& value, Domain* domain, TimeStep *tStep) override;
    const char *giveClassName() const override { return "TimeCheckingRule"; }
};
 
 

class OOFEM_EXPORT ErrorCheckingExportModule : public ExportModule
{
protected:
    std :: string filename;
    std :: vector< std :: unique_ptr< ErrorCheckingRule > > errorCheckingRules;
    bool allPassed = true;
    bool writeChecks = false;
    IntArray writeIST;
    bool extractorMode = false;
    FILE* outputFile; // for extractorMode
 
    bool scanToErrorChecks(std :: ifstream &stream, double &errorTolerance);
    std::unique_ptr<ErrorCheckingRule> giveErrorCheck(std :: ifstream &stream, double errorTolerance);
 
    void writeCheck(Domain *domain, TimeStep *tStep);
 
    void readRulesFromTextFile(InputRecord& ir);
    void readRulesFromRecords(DataReader& dr, InputRecord& ir);
public:
    ErrorCheckingExportModule(int n, EngngModel * e);
    ErrorCheckingExportModule(const ErrorCheckingExportModule &) = delete;
    ErrorCheckingExportModule &operator=(const ErrorCheckingExportModule &) = delete;
 
    void initialize() override;
    void terminate() override;
    void initializeFrom(InputRecord &ir) override;
    void doOutput(TimeStep *tStep, bool forcedOutput = false) override;
 
    const char *giveClassName() const override { return "ErrorCheckingExportModule"; }
    const char *giveInputRecordName() const { return _IFT_ErrorCheckingExportModule_Name; }
};
} // end namespace oofem
#endif // errorcheckingexportmodule_h_