oofem::GPExportModule Class Reference

#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.
virtual	~GPExportModule ()
	Destructor.
void	initializeFrom (InputRecord &ir) override
	Initializes receiver according to object description stored in input record.
void	doOutput (TimeStep *tStep, bool forcedOutput=false) override
void	initialize () 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	initializeElementSet ()

Protected Member Functions
FILE *	giveOutputStream (TimeStep *tStep)
	Returns the output stream for given solution step.
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).

Protected Attributes
IntArray	vartypes
	Identification numbers of variables to be exported.
int	ncoords
	Number of coordinates to be exported (at each Gauss point).
IntArray	elements
	List of elements.
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.

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

GPExportModule()

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

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

References doOutput(), GPExportModule(), initialize(), initializeFrom(), and terminate().

Referenced by GPExportModule().

~GPExportModule()

oofem::GPExportModule::~GPExportModule ( )

virtual

Destructor.

Definition at line 53 of file gpexportmodule.C.

Member Function Documentation

doOutput()

void oofem::GPExportModule::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 67 of file gpexportmodule.C.

References elements, oofem::ExportModule::emodel, oofem::Domain::giveElements(), oofem::ExportModule::giveNumberOfRegions(), giveOutputStream(), oofem::ExportModule::giveRegionSet(), oofem::FloatArray::giveSize(), oofem::TimeStep::giveTargetTime(), ncoords, oofem::ExportModule::testTimeStepOutput(), and vartypes.

Referenced by GPExportModule().

giveClassName()

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

inlineoverridevirtual

Returns class name of the receiver.

Implements oofem::ExportModule.

Definition at line 77 of file gpexportmodule.h.

giveInputRecordName()

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

inline

Definition at line 78 of file gpexportmodule.h.

References _IFT_GPExportModule_Name.

giveOutputStream()

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

protected

Returns the output stream for given solution step.

Definition at line 179 of file gpexportmodule.C.

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

Referenced by doOutput().

initialize()

void oofem::GPExportModule::initialize ( )

overridevirtual

Reimplemented from oofem::ExportModule.

Definition at line 167 of file gpexportmodule.C.

Referenced by GPExportModule().

initializeFrom()

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

overridevirtual

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, IR_GIVE_FIELD, IR_GIVE_OPTIONAL_FIELD, ncoords, and vartypes.

Referenced by GPExportModule().

terminate()

void oofem::GPExportModule::terminate ( )

overridevirtual

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

Reimplemented from oofem::ExportModule.

Definition at line 174 of file gpexportmodule.C.

Referenced by GPExportModule().

Member Data Documentation

elements

IntArray oofem::GPExportModule::elements

protected

List of elements.

Definition at line 65 of file gpexportmodule.h.

Referenced by doOutput().

ncoords

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().

vartypes

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:

• gpexportmodule.h
• gpexportmodule.C