datareader.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 datareader_h
#define datareader_h
 
#include "oofemenv.h"
#include "inputrecord.h"
#include "error.h"
 
#include<iostream>
#include<fstream>
 
namespace oofem {
class OOFEM_EXPORT DataReader
{
protected:
    std :: string outputFileName;
    std :: string description;
 
public:
    enum InputRecordType {
        IR_domainRec, IR_outManRec, IR_domainCompRec, IR_geometryRec, IR_gbpmRec,
        IR_emodelRec, IR_mstepRec, IR_expModuleRec, IR_dofmanRec, IR_elemRec,
        IR_crosssectRec, IR_matRec, IR_nlocBarRec, IR_bcRec, IR_icRec, IR_funcRec, IR_setRec,
        IR_xfemManRec, IR_enrichFuncRec, IR_geoRec, IR_enrichItemRec,
        IR_enrichFrontRec, IR_propagationLawRec, IR_crackNucleationRec, IR_fracManRec, IR_failCritRec,
        IR_contactSurfaceRec, IR_fieldRec, 
        // MPM specific
        IR_mpmVarRec, IR_mpmTermRec, IR_mpmIntegralRec,
        IR_unspecified // internal use only, signifies error in setting record type
    };
    /* XML tags corresponding to record types; those with "" are just enumeration group where arbitrary tags may be used */
    static constexpr const char* InputRecordTags[]={
        "Domain","OutputManager","DomainComp","Geometry","GBPM",
        "Analysis","Metastep",/*ExportModule*/"",/*Node*/"",/*Element*/"",
        /*CrossSection*/"",/*Material*/"",/*"NonlocalBarrier"*/"",/*BoundaryCondition*/"","InitialCondition",/*TimeFunction*/"","Set",
        "XFemManager","EnrichmentFunction","EnrichmentGeometry",/*EnrichmentItem*/"",
        /*EnrichmentFront*/"","PropagationLaw","CrackNucleation","FractureManager","FailCriterion",
        /*ContactSurface*/"","Field",
        "MPMVariable",/*"MPMTerm"*/"","MPMIntegral",
        "UNSPECIFIED"
    };
 
    DataReader() { }
    virtual ~DataReader() { }

    virtual InputRecord &giveInputRecord(InputRecordType irType, int recordId) = 0;
    virtual InputRecord* giveTopInputRecord(){ return nullptr; }

    virtual bool peekNext(const std :: string &keyword) { return false; }

    virtual void finish() = 0;

    virtual std :: string giveReferenceName() const = 0;
    std :: string giveOutputFileName() { return this->outputFileName; }
    std :: string giveDescription() { return this->description; }
 
    virtual bool hasFlattenedStructure() { return false; }
 
    virtual void enterGroup(const std::string& name) {};
    virtual void leaveGroup(const std::string& name) {};
    virtual void enterRecord(InputRecord* rec) {};
    virtual void leaveRecord(InputRecord* rec) {};

    class RecordGuard{
        DataReader& reader;
        InputRecord* rec;
    public:
        RecordGuard(DataReader& reader_, InputRecord* rec_): reader(reader_), rec(rec_) { reader.enterRecord(rec); }
        ~RecordGuard() { reader.leaveRecord(rec); }
    };

    class GroupRecords {
        DataReader& dr;
        std::string group;
        InputRecordType irType;
        int size_;
    public:
        class Iterator {
            DataReader& dr;
            std::string group;
            InputRecordType irType;
            int size;
            int index;
            InputRecord* irPtr=nullptr;
            bool entered=false;
        public:
            Iterator( DataReader &dr_, const std::string &group_, InputRecordType irType_, int size_, int index_ );
            Iterator &operator++();
            InputRecord& operator*() { return *irPtr; }
            bool operator!=(const Iterator& other){ return this->index!=other.index; }
            int index1() const { return index+1; }
        };
        GroupRecords( DataReader &dr_, const std::string &group_, InputRecordType irType_, int size );
        Iterator begin(){ return Iterator(dr,group,irType,size_,0); }
        Iterator end(){ return Iterator(dr,group,irType,size_,std::max(size_,0)); }
        int size(){ return size_; }
    };
 
    static const int NoSuchGroup=-1;
    virtual int giveGroupCount(const std::string& name){ return NoSuchGroup; }
    bool hasGroup(const std::string& name){ return giveGroupCount(name)>=0; }
    GroupRecords giveGroupRecords(const std::shared_ptr<InputRecord> &ir, InputFieldType ift, const std::string &name, InputRecordType irType, bool optional );
    GroupRecords giveGroupRecords(const std::string& name, InputRecordType irType, int numRequired=-1);
    InputRecord *giveChildRecord( const std::shared_ptr<InputRecord> &ir, InputFieldType ift, const std::string &name, InputRecordType irType, bool optional );
 
 
};
} // end namespace oofem
#endif // datareader_h