oofem::OutputExportModule Class Reference

#include <outputexportmodule.h>

Inheritance diagram for oofem::OutputExportModule:

Collaboration diagram for oofem::OutputExportModule:

Public Member Functions
	OutputExportModule (int n, EngngModel *e)
virtual	~OutputExportModule ()
void	initializeFrom (InputRecord &ir) override
	Initializes receiver according to object description stored in input record.
FILE *	giveOutputStream ()
void	doOutput (TimeStep *tStep, bool forcedOutput=false) override
void	terminate () override
const char *	giveClassName () const override
	Returns class name of the receiver.
const char *	giveInputRecordName () const
Public Member Functions inherited from oofem::ExportModule
	ExportModule (int n, EngngModel *e)
	Constructor. Creates empty Output Manager with number n.
virtual	~ExportModule ()
	Destructor.
void	doForcedOutput (TimeStep *tStep)
bool	testSubStepOutput ()
virtual void	initialize ()
virtual void	initializeElementSet ()

Protected Attributes
FILE *	outputStream
IntArray	nodeSets
	Set which contains nodes which should be exported.
IntArray	elementSets
	Set which contains elements which should be exported.
Protected Attributes inherited from oofem::ExportModule
int	number
	Component number.
EngngModel *	emodel
	Problem pointer.
bool	tstep_all_out_flag
	Indicates all steps selection.
int	tstep_step_out
	User timeStep Output step. Indicates every tstep_step_out-th step selected.
std ::list< Range >	tsteps_out
	List of user selected step numbers.
bool	tstep_substeps_out_flag
bool	domain_all_flag
	Indicates all domains.
IntArray	domainMask
	Domain selection mask.
IntArray	regionSets
	regions represented by sets
double	timeScale
	Scaling time in output, e.g. conversion from seconds to hours.
Set	defaultElementSet
	Default region set.
bool	pythonExport
	Output is carried out as a python list instead of writing files.

Additional Inherited Members
Protected Member Functions inherited from oofem::ExportModule
int	giveNumberOfRegions ()
	Returns number of regions (aka regionSets).
Set *	giveRegionSet (int i)
	Returns element set.
std::string	giveOutputBaseFileName (TimeStep *tStep)
bool	testTimeStepOutput (TimeStep *tStep)
bool	testDomainOutput (int n)
std::string	errorInfo (const char *func) const
	Returns string for prepending output (used by error reporting macros).

Detailed Description

Standard output for OOFEM. Most available data is written in plain text. Implementation simply relies on EngngModel::printOutputAt

Author

Mikael Öhman

Definition at line 60 of file outputexportmodule.h.

Constructor & Destructor Documentation

OutputExportModule()

oofem::OutputExportModule::OutputExportModule	(	int	n,
		EngngModel *	e )

~OutputExportModule()

virtual oofem::OutputExportModule::~OutputExportModule ( )

inlinevirtual

Definition at line 73 of file outputexportmodule.h.

Member Function Documentation

doOutput()

void oofem::OutputExportModule::doOutput ( TimeStep * tStep, bool forcedOutput = false )

overridevirtual

Writes the output. Abstract service.

Parameters

tStep	Time step.
forcedOutput	If true, no testTimeStepOutput should be done.

Implements oofem::ExportModule.

Definition at line 83 of file outputexportmodule.C.

References elementSets, oofem::ExportModule::emodel, oofem::TimeStep::giveNumber(), giveOutputStream(), oofem::TimeStep::giveTargetTime(), nodeSets, oofem::ExportModule::testTimeStepOutput(), and oofem::VST_Time.

giveClassName()

const char * oofem::OutputExportModule::giveClassName ( ) const

inlineoverridevirtual

Returns class name of the receiver.

Implements oofem::ExportModule.

Definition at line 81 of file outputexportmodule.h.

giveInputRecordName()

const char * oofem::OutputExportModule::giveInputRecordName ( ) const

inline

Definition at line 82 of file outputexportmodule.h.

References _IFT_OutputExportModule_Name.

giveOutputStream()

FILE * oofem::OutputExportModule::giveOutputStream

(

)

Definition at line 72 of file outputexportmodule.C.

References oofem::ExportModule::emodel, OOFEM_ERROR, and outputStream.

Referenced by doOutput(), initializeFrom(), and terminate().

initializeFrom()

void oofem::OutputExportModule::initializeFrom ( InputRecord & ir )

overridevirtual

Initializes receiver according to object description stored in input record.

Reimplemented from oofem::ExportModule.

Definition at line 55 of file outputexportmodule.C.

References _IFT_OutputExportModule_elementSets, _IFT_OutputExportModule_nodeSets, elementSets, oofem::ExportModule::emodel, giveOutputStream(), IR_GIVE_OPTIONAL_FIELD, nodeSets, and PRG_HEADER.

terminate()

void oofem::OutputExportModule::terminate ( )

overridevirtual

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

Reimplemented from oofem::ExportModule.

Definition at line 101 of file outputexportmodule.C.

References oofem::ExportModule::emodel, and giveOutputStream().

Member Data Documentation

elementSets

IntArray oofem::OutputExportModule::elementSets

protected

Set which contains elements which should be exported.

Definition at line 69 of file outputexportmodule.h.

Referenced by doOutput(), and initializeFrom().

nodeSets

IntArray oofem::OutputExportModule::nodeSets

protected

Set which contains nodes which should be exported.

Definition at line 66 of file outputexportmodule.h.

Referenced by doOutput(), and initializeFrom().

outputStream

FILE* oofem::OutputExportModule::outputStream

protected

Definition at line 63 of file outputexportmodule.h.

Referenced by giveOutputStream().

---

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

• outputexportmodule.h
• outputexportmodule.C