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

Represents POI (Point Of Interest) export module. More...

#include <poiexportmodule.h>

+ Inheritance diagram for oofem::POIExportModule:
+ Collaboration diagram for oofem::POIExportModule:

Classes

struct  POI_dataType
 POIs data structure. More...
 

Public Member Functions

 POIExportModule (int n, EngngModel *e)
 Constructor. Creates empty Output Manager. By default all components are selected. More...
 
virtual ~POIExportModule ()
 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 * giveInputRecordName () const
 
virtual const char * giveClassName () const
 Returns class name of the receiver. More...
 
- 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 Types

enum  POIEM_MapperType { POI_CPT, POI_SFT, POI_LST }
 Smoother type. More...
 

Protected Member Functions

void readPOIFile (const std::string &poiFileName)
 
FILE * giveOutputStream (TimeStep *tStep)
 Returns the output stream for given solution step. More...
 
void exportIntVars (FILE *stream, TimeStep *tStep)
 Export internal variables. More...
 
void exportPrimaryVars (FILE *stream, TimeStep *tStep)
 Export primary variables. More...
 
void exportIntVarAs (InternalStateType valID, FILE *stream, TimeStep *tStep)
 Exports single variable. More...
 
void exportPrimVarAs (UnknownType valID, FILE *stream, TimeStep *tStep)
 Exports single variable. More...
 
MaterialMappingAlgorithmgiveMapper ()
 
- 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 internalVarsToExport
 List of InternalStateType values, identifying the selected vars for export. More...
 
IntArray primaryVarsToExport
 List of primary unknowns to export. More...
 
std::list< POI_dataTypePOIList
 List of POIs. More...
 
enum oofem::POIExportModule::POIEM_MapperType mtype
 
std::unique_ptr< MaterialMappingAlgorithmmapper
 Mapper. 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 POI (Point Of Interest) export module.

It is able to perform output on given points, which are inside domain but can have arbitrary position.

Definition at line 62 of file poiexportmodule.h.

Member Enumeration Documentation

Smoother type.

Enumerator
POI_CPT 
POI_SFT 
POI_LST 

Definition at line 81 of file poiexportmodule.h.

Constructor & Destructor Documentation

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

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

oofem::POIExportModule::~POIExportModule ( )
virtual

Destructor.

Definition at line 60 of file poiexportmodule.C.

Member Function Documentation

void oofem::POIExportModule::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 105 of file poiexportmodule.C.

References exportIntVars(), exportPrimaryVars(), giveOutputStream(), oofem::TimeStep::giveTargetTime(), and oofem::ExportModule::testTimeStepOutput().

void oofem::POIExportModule::exportPrimaryVars ( FILE *  stream,
TimeStep tStep 
)
protected
virtual const char* oofem::POIExportModule::giveClassName ( ) const
inlinevirtual

Returns class name of the receiver.

Implements oofem::ExportModule.

Definition at line 98 of file poiexportmodule.h.

References exportIntVarAs(), exportIntVars(), exportPrimaryVars(), exportPrimVarAs(), giveMapper(), giveOutputStream(), and readPOIFile().

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

Definition at line 97 of file poiexportmodule.h.

References _IFT_POIExportModule_Name.

MaterialMappingAlgorithm * oofem::POIExportModule::giveMapper ( )
protected

Definition at line 209 of file poiexportmodule.C.

References mapper, mtype, OOFEM_ERROR, POI_CPT, POI_LST, and POI_SFT.

Referenced by exportIntVarAs(), exportIntVars(), and giveClassName().

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

Returns the output stream for given solution step.

Definition at line 135 of file poiexportmodule.C.

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

Referenced by doOutput(), and giveClassName().

void oofem::POIExportModule::initialize ( )
virtual

Reimplemented from oofem::ExportModule.

Definition at line 123 of file poiexportmodule.C.

References oofem::ExportModule::initialize().

IRResultType oofem::POIExportModule::initializeFrom ( InputRecord ir)
virtual
void oofem::POIExportModule::terminate ( )
virtual

Terminates the receiver.

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

Reimplemented from oofem::ExportModule.

Definition at line 130 of file poiexportmodule.C.

Member Data Documentation

IntArray oofem::POIExportModule::internalVarsToExport
protected

List of InternalStateType values, identifying the selected vars for export.

Definition at line 74 of file poiexportmodule.h.

Referenced by exportIntVars(), and initializeFrom().

std :: unique_ptr< MaterialMappingAlgorithm > oofem::POIExportModule::mapper
protected

Mapper.

Definition at line 83 of file poiexportmodule.h.

Referenced by giveMapper().

enum oofem::POIExportModule::POIEM_MapperType oofem::POIExportModule::mtype
protected

Referenced by giveMapper(), and initializeFrom().

std :: list< POI_dataType > oofem::POIExportModule::POIList
protected

List of POIs.

Definition at line 78 of file poiexportmodule.h.

Referenced by exportIntVarAs(), exportIntVars(), exportPrimVarAs(), and readPOIFile().

IntArray oofem::POIExportModule::primaryVarsToExport
protected

List of primary unknowns to export.

Definition at line 76 of file poiexportmodule.h.

Referenced by exportPrimaryVars(), 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:39 for OOFEM by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2011