exportmodule.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2013   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 exportmodule_h
#define exportmodule_h

#include "oofemcfg.h"
#include "intarray.h"
#include "inputrecord.h"
#include "range.h"
#include "set.h"

#include <list>


#define _IFT_ExportModule_tstepall "tstep_all"
#define _IFT_ExportModule_tstepstep "tstep_step"
#define _IFT_ExportModule_tstepsout "tsteps_out"
#define _IFT_ExportModule_subtstepsout "subtsteps_out"
#define _IFT_ExportModule_domainall "domain_all"
#define _IFT_ExportModule_domainmask "domain_mask"
#define _IFT_ExportModule_regionsets "regionsets"
#define _IFT_ExportModule_timescale "timescale"


namespace oofem {
class EngngModel;
class TimeStep;

class OOFEM_EXPORT ExportModule
{
protected:
    int number;
    EngngModel *emodel;
    bool tstep_all_out_flag;
    int tstep_step_out;
    std :: list< Range >tsteps_out;
    bool tstep_substeps_out_flag;

    bool domain_all_flag;
    IntArray domainMask;

    IntArray regionSets;

    double timeScale;

    int giveNumberOfRegions();

    Set defaultElementSet;

    Set *giveRegionSet(int i);

public:

    ExportModule(int n, EngngModel * e);
    virtual ~ExportModule();
    virtual IRResultType initializeFrom(InputRecord *ir);
    virtual void doOutput(TimeStep *tStep, bool forcedOutput = false) = 0;
    void doForcedOutput(TimeStep *tStep) { doOutput(tStep, true); }
    bool testSubStepOutput() { return this->tstep_substeps_out_flag; }

    virtual void initialize();

    virtual void initializeElementSet();

    virtual void terminate() { }
    virtual const char *giveClassName() const = 0;

protected:
    std :: string giveOutputBaseFileName(TimeStep *tStep);
    bool testTimeStepOutput(TimeStep *tStep);
    bool testDomainOutput(int n);

    std :: string errorInfo(const char *func) const;
};
} // end namespace oofem
#endif // exportmodule_h