oofem::ExportModule Class Reference

#include <exportmodule.h>

Inheritance diagram for oofem::ExportModule:

Collaboration diagram for oofem::ExportModule:

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

Protected Member Functions
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).

Protected Attributes
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.

Detailed Description

Represents export output module - a base class for all output modules. ExportModule is an abstraction for module performing some specific kind of output. The modules can declare necessary component services using the interface concept. The basic class declares the basic services (the general interface) and implements the services intended to filter output to certain time steps. The output modules are maintained by ExportModuleManager. The output for given time step is done only if this step is selected by one of above described method.

Definition at line 72 of file exportmodule.h.

Constructor & Destructor Documentation

ExportModule()

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

Constructor. Creates empty Output Manager with number n.

Definition at line 44 of file exportmodule.C.

References defaultElementSet, domainMask, emodel, number, pythonExport, regionSets, timeScale, and tsteps_out.

Referenced by oofem::ErrorCheckingExportModule::ErrorCheckingExportModule(), and oofem::VTKBaseExportModule::VTKBaseExportModule().

~ExportModule()

oofem::ExportModule::~ExportModule ( )

virtual

Destructor.

Definition at line 54 of file exportmodule.C.

Member Function Documentation

doForcedOutput()

void oofem::ExportModule::doForcedOutput ( TimeStep * tStep )

inline

Writes the output. Abstract service.

Parameters

tStep

time step.

Definition at line 135 of file exportmodule.h.

References doOutput().

doOutput()

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

pure virtual

Writes the output. Abstract service.

Parameters

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

Implemented in oofem::CrackExportModule, oofem::DofManExportModule, oofem::ErrorCheckingExportModule, oofem::GnuplotExportModule, oofem::GPExportModule, oofem::HOMExportModule, oofem::MatlabExportModule, oofem::OutputExportModule, oofem::POIExportModule, oofem::SolutionStatusExportModule, oofem::VTKExportModule, oofem::VTKHDF5ExportModule, oofem::VTKMemoryExportModule, oofem::VTKPFEMXMLExportModule, oofem::VTKXMLExportModule, oofem::VTKXMLLatticeExportModule, and oofem::VTKXMLXFemExportModule.

Referenced by doForcedOutput().

errorInfo()

std::string oofem::ExportModule::errorInfo ( const char * func ) const

protected

Returns string for prepending output (used by error reporting macros).

Definition at line 179 of file exportmodule.C.

References giveClassName().

Referenced by giveClassName().

giveClassName()

virtual const char * oofem::ExportModule::giveClassName ( ) const

pure virtual

Returns class name of the receiver.

Implemented in oofem::CrackExportModule, oofem::DofManExportModule, oofem::ErrorCheckingExportModule, oofem::GnuplotExportModule, oofem::GPExportModule, oofem::HOMExportModule, oofem::MatlabExportModule, oofem::OutputExportModule, oofem::POIExportModule, oofem::SolutionStatusExportModule, oofem::VTKBaseExportModule, oofem::VTKExportModule, oofem::VTKHDF5ExportModule, oofem::VTKXMLExportModule, oofem::VTKXMLLatticeExportModule, oofem::VTKXMLPeriodicExportModule, and oofem::VTKXMLXFemExportModule.

References errorInfo(), giveOutputBaseFileName(), testDomainOutput(), and testTimeStepOutput().

Referenced by errorInfo().

giveNumberOfRegions()

int oofem::ExportModule::giveNumberOfRegions ( )

protected

Returns number of regions (aka regionSets).

Definition at line 99 of file exportmodule.C.

References regionSets.

Referenced by oofem::GPExportModule::doOutput(), oofem::HOMExportModule::doOutput(), oofem::VTKHDF5ExportModule::doOutput(), oofem::VTKMemoryExportModule::doOutput(), oofem::VTKXMLExportModule::doOutput(), oofem::VTKXMLXFemExportModule::doOutput(), oofem::VTKXMLLatticeExportModule::doOutputCross(), oofem::VTKXMLLatticeExportModule::doOutputNormal(), and oofem::VTKXMLExportModule::exportIntVarsInGpAs().

giveOutputBaseFileName()

std::string oofem::ExportModule::giveOutputBaseFileName ( TimeStep * tStep )

protected

Gives the appropriate name (minus specific file extension).

Parameters

tStep

Active time step.

Definition at line 123 of file exportmodule.C.

References emodel, oofem::TimeStep::giveNumber(), oofem::TimeStep::giveSubStepNumber(), number, and testSubStepOutput().

Referenced by oofem::CrackExportModule::doOutput(), oofem::VTKXMLExportModule::doOutput(), oofem::VTKXMLExportModule::exportIntVarsInGpAs(), giveClassName(), oofem::VTKPFEMXMLExportModule::giveOutputFileName(), oofem::VTKXMLExportModule::giveOutputFileName(), oofem::VTKXMLXFemExportModule::giveOutputFileName(), oofem::VTKXMLLatticeExportModule::giveOutputFileNameCross(), oofem::DofManExportModule::giveOutputStream(), oofem::GPExportModule::giveOutputStream(), oofem::POIExportModule::giveOutputStream(), and oofem::VTKExportModule::giveOutputStream().

giveRegionSet()

Set * oofem::ExportModule::giveRegionSet ( int i )

protected

Returns element set.

Definition at line 108 of file exportmodule.C.

References defaultElementSet, emodel, OOFEM_ERROR, and regionSets.

Referenced by oofem::GPExportModule::doOutput(), oofem::HOMExportModule::doOutput(), oofem::VTKHDF5ExportModule::doOutput(), oofem::VTKMemoryExportModule::doOutput(), oofem::VTKXMLExportModule::doOutput(), oofem::VTKXMLXFemExportModule::doOutput(), oofem::VTKXMLLatticeExportModule::doOutputCross(), oofem::VTKXMLLatticeExportModule::doOutputNormal(), and oofem::VTKXMLExportModule::exportIntVarsInGpAs().

initialize()

void oofem::ExportModule::initialize ( )

virtual

Reimplemented in oofem::CrackExportModule, oofem::ErrorCheckingExportModule, oofem::GnuplotExportModule, oofem::GPExportModule, oofem::HOMExportModule, oofem::MatlabExportModule, oofem::POIExportModule, oofem::SolutionStatusExportModule, oofem::VTKBaseExportModule, oofem::VTKExportModule, oofem::VTKHDF5ExportModule, and oofem::VTKXMLExportModule.

Definition at line 85 of file exportmodule.C.

References initializeElementSet().

Referenced by oofem::VTKBaseExportModule::initialize(), and oofem::AdditiveManufacturingProblem::solveYourself().

initializeElementSet()

void oofem::ExportModule::initializeElementSet ( )

virtual

Fill regionSets with all elements if regionSets is initially empty. Implementation depends on derived classes.

Definition at line 89 of file exportmodule.C.

References defaultElementSet, emodel, and regionSets.

Referenced by initialize(), and oofem::HOMExportModule::initialize().

initializeFrom()

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

virtual

Initializes receiver according to object description stored in input record.

Reimplemented in oofem::CrackExportModule, oofem::DofManExportModule, oofem::ErrorCheckingExportModule, oofem::GnuplotExportModule, oofem::GPExportModule, oofem::HOMExportModule, oofem::MatlabExportModule, oofem::OutputExportModule, oofem::POIExportModule, oofem::QuasicontinuumVTKXMLExportModule, oofem::SolutionStatusExportModule, oofem::VTKExportModule, oofem::VTKHDF5ExportModule, oofem::VTKMemoryExportModule, oofem::VTKPFEMXMLExportModule, oofem::VTKXMLExportModule, oofem::VTKXMLLatticeExportModule, oofem::VTKXMLPeriodicExportModule, and oofem::VTKXMLXFemExportModule.

Definition at line 59 of file exportmodule.C.

References _IFT_ExportModule_domainall, _IFT_ExportModule_domainmask, _IFT_ExportModule_pythonexport, _IFT_ExportModule_regionsets, _IFT_ExportModule_subtstepsout, _IFT_ExportModule_timescale, _IFT_ExportModule_tstepall, _IFT_ExportModule_tstepsout, _IFT_ExportModule_tstepstep, domain_all_flag, domainMask, oofem::InputRecord::hasField(), IR_GIVE_OPTIONAL_FIELD, pythonExport, regionSets, timeScale, tstep_all_out_flag, tstep_step_out, tstep_substeps_out_flag, and tsteps_out.

Referenced by oofem::GnuplotExportModule::initializeFrom(), oofem::VTKHDF5ExportModule::initializeFrom(), oofem::VTKMemoryExportModule::initializeFrom(), oofem::VTKPFEMXMLExportModule::initializeFrom(), oofem::VTKXMLExportModule::initializeFrom(), and oofem::VTKXMLXFemExportModule::initializeFrom().

terminate()

virtual void oofem::ExportModule::terminate ( )

inlinevirtual

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

Reimplemented in oofem::CrackExportModule, oofem::ErrorCheckingExportModule, oofem::GnuplotExportModule, oofem::GPExportModule, oofem::HOMExportModule, oofem::MatlabExportModule, oofem::OutputExportModule, oofem::POIExportModule, oofem::SolutionStatusExportModule, oofem::VTKBaseExportModule, oofem::VTKExportModule, oofem::VTKHDF5ExportModule, oofem::VTKXMLExportModule, and oofem::VTKXMLXFemExportModule.

Definition at line 158 of file exportmodule.h.

testDomainOutput()

bool oofem::ExportModule::testDomainOutput ( int n )

protected

Test if domain output is required.

Returns

True if required.

Definition at line 170 of file exportmodule.C.

References domain_all_flag, and domainMask.

Referenced by giveClassName().

testSubStepOutput()

bool oofem::ExportModule::testSubStepOutput ( )

inline

Initializes receiver. The init file messages should be printed. Returns true if module is configured to export indvidual substep/iterations.

Definition at line 143 of file exportmodule.h.

Referenced by giveOutputBaseFileName(), and oofem::MatlabExportModule::giveOutputStream().

testTimeStepOutput()

bool oofem::ExportModule::testTimeStepOutput ( TimeStep * tStep )

protected

Tests if given time step output is required.

Parameters

tStep

Time step to check.

Returns

True if output required.

Definition at line 146 of file exportmodule.C.

References oofem::TimeStep::giveNumber(), tstep_all_out_flag, tstep_step_out, and tsteps_out.

Referenced by oofem::CrackExportModule::doOutput(), oofem::DofManExportModule::doOutput(), oofem::ErrorCheckingExportModule::doOutput(), oofem::GnuplotExportModule::doOutput(), oofem::GPExportModule::doOutput(), oofem::HOMExportModule::doOutput(), oofem::MatlabExportModule::doOutput(), oofem::OutputExportModule::doOutput(), oofem::POIExportModule::doOutput(), oofem::SolutionStatusExportModule::doOutput(), oofem::VTKExportModule::doOutput(), oofem::VTKHDF5ExportModule::doOutput(), oofem::VTKMemoryExportModule::doOutput(), oofem::VTKPFEMXMLExportModule::doOutput(), oofem::VTKXMLExportModule::doOutput(), oofem::VTKXMLXFemExportModule::doOutput(), oofem::VTKXMLLatticeExportModule::doOutputCross(), oofem::VTKXMLLatticeExportModule::doOutputNormal(), giveClassName(), and oofem::GnuplotExportModule::outputReactionForces().

Member Data Documentation

defaultElementSet

Set oofem::ExportModule::defaultElementSet

protected

Default region set.

Definition at line 108 of file exportmodule.h.

Referenced by ExportModule(), giveRegionSet(), and initializeElementSet().

domain_all_flag

bool oofem::ExportModule::domain_all_flag

protected

Indicates all domains.

Definition at line 94 of file exportmodule.h.

Referenced by initializeFrom(), and testDomainOutput().

domainMask

IntArray oofem::ExportModule::domainMask

protected

Domain selection mask.

Definition at line 96 of file exportmodule.h.

Referenced by ExportModule(), initializeFrom(), and testDomainOutput().

emodel

EngngModel* oofem::ExportModule::emodel

protected

Problem pointer.

Definition at line 78 of file exportmodule.h.

Referenced by oofem::HOMExportModule::average(), oofem::MatlabExportModule::computeArea(), oofem::CrackExportModule::doOutput(), oofem::DofManExportModule::doOutput(), oofem::ErrorCheckingExportModule::doOutput(), oofem::GnuplotExportModule::doOutput(), oofem::GPExportModule::doOutput(), oofem::MatlabExportModule::doOutput(), oofem::OutputExportModule::doOutput(), oofem::VTKExportModule::doOutput(), oofem::VTKMemoryExportModule::doOutput(), oofem::VTKPFEMXMLExportModule::doOutput(), oofem::VTKXMLExportModule::doOutput(), oofem::VTKXMLXFemExportModule::doOutput(), oofem::MatlabExportModule::doOutputData(), oofem::MatlabExportModule::doOutputHomogenizeDofIDs(), oofem::MatlabExportModule::doOutputIntegrationPointFields(), oofem::MatlabExportModule::doOutputMesh(), oofem::VTKXMLLatticeExportModule::doOutputNormal(), oofem::MatlabExportModule::doOutputReactionForces(), oofem::MatlabExportModule::doOutputSpecials(), oofem::VTKBaseExportModule::exportCellVars(), oofem::VTKExportModule::exportCellVars(), oofem::VTKBaseExportModule::exportExternalForces(), oofem::POIExportModule::exportIntVarAs(), oofem::VTKExportModule::exportIntVarAs(), oofem::VTKBaseExportModule::exportIntVars(), oofem::VTKXMLLatticeExportModule::exportIntVars(), oofem::VTKXMLPeriodicExportModule::exportIntVars(), oofem::VTKXMLXFemExportModule::exportIntVars2(), oofem::VTKXMLExportModule::exportIntVarsInGpAs(), ExportModule(), oofem::POIExportModule::exportPrimaryVars(), oofem::VTKBaseExportModule::exportPrimaryVars(), oofem::VTKXMLLatticeExportModule::exportPrimaryVars(), oofem::VTKXMLPeriodicExportModule::exportPrimaryVars(), oofem::POIExportModule::exportPrimVarAs(), oofem::VTKExportModule::exportPrimVarAs(), oofem::VTKBaseExportModule::exportSetMembership(), oofem::VTKBaseExportModule::getCellVariableFromIS(), oofem::VTKBaseExportModule::getNodalVariableFromIS(), oofem::VTKXMLXFemExportModule::getNodalVariableFromXFEMST(), oofem::VTKBaseExportModule::giveCellType(), oofem::VTKXMLXFemExportModule::giveDataHeaders(), giveOutputBaseFileName(), oofem::MatlabExportModule::giveOutputStream(), oofem::OutputExportModule::giveOutputStream(), oofem::VTKHDF5ExportModule::givePrimVarSmoother(), oofem::VTKXMLExportModule::givePrimVarSmoother(), giveRegionSet(), oofem::VTKExportModule::giveSmoother(), oofem::VTKHDF5ExportModule::giveSmoother(), oofem::VTKXMLExportModule::giveSmoother(), oofem::ErrorCheckingExportModule::initialize(), oofem::HOMExportModule::initialize(), oofem::SolutionStatusExportModule::initialize(), oofem::VTKHDF5ExportModule::initialize(), initializeElementSet(), oofem::ErrorCheckingExportModule::initializeFrom(), oofem::OutputExportModule::initializeFrom(), oofem::GnuplotExportModule::outputBoundaryCondition(), oofem::GnuplotExportModule::outputBoundaryCondition(), oofem::GnuplotExportModule::outputBoundaryCondition(), oofem::GnuplotExportModule::outputInterfaceEl(), oofem::GnuplotExportModule::outputMesh(), oofem::GnuplotExportModule::outputReactionForces(), oofem::GnuplotExportModule::outputXFEM(), oofem::GnuplotExportModule::outputXFEMGeometry(), oofem::QuasicontinuumVTKXMLExportModule::setupVTKPiece(), oofem::VTKBaseExportModule::setupVTKPiece(), oofem::VTKXMLLatticeExportModule::setupVTKPiece(), oofem::VTKXMLPeriodicExportModule::setupVTKPiece(), oofem::VTKXMLLatticeExportModule::setupVTKPieceCross(), oofem::OutputExportModule::terminate(), oofem::SolutionStatusExportModule::terminate(), oofem::VTKXMLExportModule::writeGPVTKCollection(), oofem::VTKXMLExportModule::writeVTKCollection(), and oofem::VTKXMLXFemExportModule::writeXFEMVars().

number

int oofem::ExportModule::number

protected

Component number.

Definition at line 76 of file exportmodule.h.

Referenced by oofem::VTKXMLExportModule::doOutput(), ExportModule(), giveOutputBaseFileName(), oofem::MatlabExportModule::giveOutputStream(), oofem::HOMExportModule::initialize(), oofem::VTKHDF5ExportModule::initialize(), oofem::VTKXMLExportModule::writeGPVTKCollection(), and oofem::VTKXMLExportModule::writeVTKCollection().

pythonExport

bool oofem::ExportModule::pythonExport

protected

Output is carried out as a python list instead of writing files.

Definition at line 114 of file exportmodule.h.

Referenced by oofem::VTKXMLExportModule::exportIntVarsInGpAs(), ExportModule(), oofem::VTKPFEMXMLExportModule::giveOutputStream(), oofem::VTKXMLExportModule::giveOutputStream(), oofem::VTKXMLXFemExportModule::giveOutputStream(), oofem::VTKXMLLatticeExportModule::giveOutputStreamCross(), initializeFrom(), oofem::VTKXMLLatticeExportModule::writeCellVarsCross(), and oofem::VTKXMLExportModule::writeVTKCollection().

regionSets

IntArray oofem::ExportModule::regionSets

protected

regions represented by sets

Definition at line 99 of file exportmodule.h.

Referenced by ExportModule(), giveNumberOfRegions(), giveRegionSet(), initializeElementSet(), and initializeFrom().

timeScale

double oofem::ExportModule::timeScale

protected

Scaling time in output, e.g. conversion from seconds to hours.

Definition at line 102 of file exportmodule.h.

Referenced by oofem::HOMExportModule::doOutput(), oofem::VTKPFEMXMLExportModule::doOutput(), oofem::VTKXMLExportModule::doOutput(), oofem::VTKXMLXFemExportModule::doOutput(), oofem::VTKXMLLatticeExportModule::doOutputCross(), oofem::VTKXMLLatticeExportModule::doOutputNormal(), ExportModule(), and initializeFrom().

tstep_all_out_flag

bool oofem::ExportModule::tstep_all_out_flag

protected

Indicates all steps selection.

Definition at line 80 of file exportmodule.h.

Referenced by initializeFrom(), and testTimeStepOutput().

tstep_step_out

int oofem::ExportModule::tstep_step_out

protected

User timeStep Output step. Indicates every tstep_step_out-th step selected.

Definition at line 82 of file exportmodule.h.

Referenced by initializeFrom(), and testTimeStepOutput().

tstep_substeps_out_flag

bool oofem::ExportModule::tstep_substeps_out_flag

protected

Flag turning output in solution step substeps/itarations. Allows to visualize the varibles during equilibrium iterations, etc. Usefull for debugging. In this case the export module output name will contain timeStep substep number. This tStep substep must be set/managed by corresponding engineering model.

Definition at line 91 of file exportmodule.h.

Referenced by oofem::VTKXMLExportModule::doOutput(), initializeFrom(), oofem::VTKXMLExportModule::writeGPVTKCollection(), and oofem::VTKXMLExportModule::writeVTKCollection().

tsteps_out

std :: list< Range > oofem::ExportModule::tsteps_out

protected

List of user selected step numbers.

Definition at line 84 of file exportmodule.h.

Referenced by ExportModule(), initializeFrom(), and testTimeStepOutput().

---

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

• exportmodule.h
• exportmodule.C