OOFEM  2.4
OOFEM.org - Object Oriented Finite Element Solver
oofem::GPExportModule Class Reference

Represents GP (Gauss point) export module. More...

#include <gpexportmodule.h>

+ Inheritance diagram for oofem::GPExportModule:
+ Collaboration diagram for oofem::GPExportModule:

Public Member Functions

 GPExportModule (int n, EngngModel *e)
 Constructor. Creates empty Output Manager. By default all components are selected. More...
 
virtual ~GPExportModule ()
 Destructor. More...
 
virtual IRResultType initializeFrom (InputRecord *ir)
 Initializes receiver according to object description stored in input record. More...
 
virtual void doOutput (TimeStep *tStep, bool forcedOutput=false)
 Writes the output. More...
 
virtual void initialize ()
 
virtual void terminate ()
 Terminates the receiver. More...
 
virtual const char * giveClassName () const
 Returns class name of the receiver. More...
 
virtual const char * giveInputRecordName () const
 
- Public Member Functions inherited from oofem::ExportModule
 ExportModule (int n, EngngModel *e)
 Constructor. Creates empty Output Manager with number n. More...
 
virtual ~ExportModule ()
 Destructor. More...
 
void doForcedOutput (TimeStep *tStep)
 Writes the output. More...
 
bool testSubStepOutput ()
 Initializes receiver. More...
 
virtual void initializeElementSet ()
 Fill regionSets with all elements if regionSets is initially empty. More...
 

Protected Member Functions

FILE * giveOutputStream (TimeStep *tStep)
 Returns the output stream for given solution step. More...
 
- Protected Member Functions inherited from oofem::ExportModule
int giveNumberOfRegions ()
 Returns number of regions (aka regionSets) More...
 
SetgiveRegionSet (int i)
 Returns element set. More...
 
std::string giveOutputBaseFileName (TimeStep *tStep)
 Gives the appropriate name (minus specific file extension). More...
 
bool testTimeStepOutput (TimeStep *tStep)
 Tests if given time step output is required. More...
 
bool testDomainOutput (int n)
 Test if domain output is required. More...
 
std::string errorInfo (const char *func) const
 Returns string for prepending output (used by error reporting macros). More...
 

Protected Attributes

IntArray vartypes
 Identification numbers of variables to be exported. More...
 
int ncoords
 Number of coordinates to be exported (at each Gauss point) More...
 
- Protected Attributes inherited from oofem::ExportModule
int number
 Component number. More...
 
EngngModelemodel
 Problem pointer. More...
 
bool tstep_all_out_flag
 Indicates all steps selection. More...
 
int tstep_step_out
 User timeStep Output step. Indicates every tstep_step_out-th step selected. More...
 
std::list< Rangetsteps_out
 List of user selected step numbers. More...
 
bool tstep_substeps_out_flag
 Flag turning output in solution step substeps/itarations. More...
 
bool domain_all_flag
 Indicates all domains. More...
 
IntArray domainMask
 Domain selection mask. More...
 
IntArray regionSets
 regions represented by sets More...
 
double timeScale
 Scaling time in output, e.g. conversion from seconds to hours. More...
 
Set defaultElementSet
 Default region set. More...
 

Detailed Description

Represents GP (Gauss point) export module.

This module writes the coordinates of all Gauss points along with the values of certain internal variables for further processing.

Definition at line 57 of file gpexportmodule.h.

Constructor & Destructor Documentation

oofem::GPExportModule::GPExportModule ( int  n,
EngngModel e 
)

Constructor. Creates empty Output Manager. By default all components are selected.

oofem::GPExportModule::~GPExportModule ( )
virtual

Destructor.

Definition at line 53 of file gpexportmodule.C.

Member Function Documentation

void oofem::GPExportModule::doOutput ( TimeStep tStep,
bool  forcedOutput = false 
)
virtual

Writes the output.

Abstract service.

Parameters
tStepTime step.
forcedOutputIf true, no testTimeStepOutput should be done.

Implements oofem::ExportModule.

Definition at line 69 of file gpexportmodule.C.

References oofem::ExportModule::emodel, oofem::EngngModel::giveDomain(), oofem::Domain::giveElements(), giveOutputStream(), oofem::IntArray::giveSize(), oofem::FloatArray::giveSize(), oofem::TimeStep::giveTargetTime(), ncoords, oofem::ExportModule::testTimeStepOutput(), and vartypes.

virtual const char* oofem::GPExportModule::giveClassName ( ) const
inlinevirtual

Returns class name of the receiver.

Implements oofem::ExportModule.

Definition at line 75 of file gpexportmodule.h.

virtual const char* oofem::GPExportModule::giveInputRecordName ( ) const
inlinevirtual

Definition at line 76 of file gpexportmodule.h.

References _IFT_GPExportModule_Name.

FILE * oofem::GPExportModule::giveOutputStream ( TimeStep tStep)
protected

Returns the output stream for given solution step.

Definition at line 174 of file gpexportmodule.C.

References oofem::ExportModule::giveOutputBaseFileName(), and OOFEM_ERROR.

Referenced by doOutput().

void oofem::GPExportModule::initialize ( )
virtual

Reimplemented from oofem::ExportModule.

Definition at line 162 of file gpexportmodule.C.

References oofem::ExportModule::initialize().

IRResultType oofem::GPExportModule::initializeFrom ( InputRecord ir)
virtual

Initializes receiver according to object description stored in input record.

Reimplemented from oofem::ExportModule.

Definition at line 58 of file gpexportmodule.C.

References _IFT_GPExportModule_ncoords, _IFT_GPExportModule_vartypes, oofem::ExportModule::initializeFrom(), IR_GIVE_FIELD, IR_GIVE_OPTIONAL_FIELD, ncoords, and vartypes.

void oofem::GPExportModule::terminate ( )
virtual

Terminates the receiver.

The terminating messages should be printed. All the streams should be closed.

Reimplemented from oofem::ExportModule.

Definition at line 169 of file gpexportmodule.C.

Member Data Documentation

int oofem::GPExportModule::ncoords
protected

Number of coordinates to be exported (at each Gauss point)

Definition at line 63 of file gpexportmodule.h.

Referenced by doOutput(), and initializeFrom().

IntArray oofem::GPExportModule::vartypes
protected

Identification numbers of variables to be exported.

Definition at line 61 of file gpexportmodule.h.

Referenced by doOutput(), and initializeFrom().


The documentation for this class was generated from the following files:

This page is part of the OOFEM documentation. Copyright (c) 2011 Borek Patzak
Project e-mail: info@oofem.org
Generated at Tue Jan 2 2018 20:07:36 for OOFEM by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2011