#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.
virtual	~POIExportModule ()
	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 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.
void	exportIntVars (FILE stream, TimeStep tStep)
void	exportPrimaryVars (FILE stream, TimeStep tStep)
void	exportIntVarAs (InternalStateType valID, FILE stream, TimeStep tStep)
void	exportPrimVarAs (UnknownType valID, FILE stream, TimeStep tStep)
MaterialMappingAlgorithm *	giveMapper ()
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	internalVarsToExport
	List of InternalStateType values, identifying the selected vars for export.
IntArray	primaryVarsToExport
	List of primary unknowns to export.
std ::list< POI_dataType >	POIList
	List of POIs.
enum oofem::POIExportModule::POIEM_MapperType	mtype
std ::unique_ptr< MaterialMappingAlgorithm >	mapper
	Mapper.
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 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

◆ POIEM_MapperType

enum oofem::POIExportModule::POIEM_MapperType

protected

Smoother type.

Enumerator
POI_CPT
POI_SFT
POI_LST

Definition at line 81 of file poiexportmodule.h.

Constructor & Destructor Documentation

◆ POIExportModule()

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

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

◆ ~POIExportModule()

oofem::POIExportModule::~POIExportModule ( )

virtual

Destructor.

Definition at line 60 of file poiexportmodule.C.

Member Function Documentation

◆ doOutput()

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

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

◆ exportIntVarAs()

void oofem::POIExportModule::exportIntVarAs	(	InternalStateType	valID,
		FILE *	stream,
		TimeStep *	tStep )

protected

Exports single variable

Definition at line 175 of file poiexportmodule.C.

References oofem::FloatArray::at(), oofem::IntArray::at(), oofem::FloatArray::clear(), oofem::ExportModule::emodel, giveMapper(), oofem::Domain::giveSet(), OOFEM_WARNING, and POIList.

Referenced by exportIntVars().

◆ exportIntVars()

void oofem::POIExportModule::exportIntVars	(	FILE *	stream,
		TimeStep *	tStep )

protected

Export internal variables.

Definition at line 147 of file poiexportmodule.C.

References oofem::FloatArray::at(), exportIntVarAs(), giveMapper(), internalVarsToExport, POIList, oofem::POIExportModule::POI_dataType::x, oofem::POIExportModule::POI_dataType::y, and oofem::POIExportModule::POI_dataType::z.

Referenced by doOutput().

◆ exportPrimaryVars()

void oofem::POIExportModule::exportPrimaryVars	(	FILE *	stream,
		TimeStep *	tStep )

protected

Export primary variables.

Definition at line 227 of file poiexportmodule.C.

References oofem::ExportModule::emodel, exportPrimVarAs(), oofem::Domain::giveNumberOfDofManagers(), and primaryVarsToExport.

Referenced by doOutput().

◆ exportPrimVarAs()

void oofem::POIExportModule::exportPrimVarAs	(	UnknownType	valID,
		FILE *	stream,
		TimeStep *	tStep )

protected

Exports single variable

Definition at line 248 of file poiexportmodule.C.

References oofem::Element::computeField(), oofem::ExportModule::emodel, oofem::SpatialLocalizer::giveElementClosestToPoint(), oofem::Domain::giveSpatialLocalizer(), oofem::ISVT_SCALAR, oofem::ISVT_UNDEFINED, oofem::ISVT_VECTOR, OOFEM_ERROR, and POIList.

Referenced by exportPrimaryVars().

◆ giveClassName()

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

inlineoverridevirtual

Returns class name of the receiver.

Implements oofem::ExportModule.

Definition at line 97 of file poiexportmodule.h.

◆ giveInputRecordName()

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

inline

Definition at line 98 of file poiexportmodule.h.

References _IFT_POIExportModule_Name.

◆ giveMapper()

MaterialMappingAlgorithm * oofem::POIExportModule::giveMapper ( )

protected

Definition at line 208 of file poiexportmodule.C.

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

Referenced by exportIntVarAs(), and exportIntVars().

◆ giveOutputStream()

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

protected

Returns the output stream for given solution step.

Definition at line 134 of file poiexportmodule.C.

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

Referenced by doOutput().

◆ initialize()

void oofem::POIExportModule::initialize ( )

overridevirtual

Reimplemented from oofem::ExportModule.

Definition at line 122 of file poiexportmodule.C.

◆ initializeFrom()

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

overridevirtual

Initializes receiver according to object description stored in input record.

Reimplemented from oofem::ExportModule.

Definition at line 66 of file poiexportmodule.C.

References _IFT_POIExportModule_mtype, _IFT_POIExportModule_poifilename, _IFT_POIExportModule_primvars, _IFT_POIExportModule_vars, internalVarsToExport, IR_GIVE_OPTIONAL_FIELD, mtype, primaryVarsToExport, and readPOIFile().

◆ readPOIFile()

void oofem::POIExportModule::readPOIFile ( const std ::string & poiFileName )

protected

Definition at line 85 of file poiexportmodule.C.

References oofem::POIExportModule::POI_dataType::id, OOFEM_ERROR, POIList, oofem::POIExportModule::POI_dataType::region, oofem::POIExportModule::POI_dataType::x, oofem::POIExportModule::POI_dataType::y, and oofem::POIExportModule::POI_dataType::z.

Referenced by initializeFrom().

◆ terminate()

void oofem::POIExportModule::terminate ( )

overridevirtual

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

Reimplemented from oofem::ExportModule.

Definition at line 129 of file poiexportmodule.C.

Member Data Documentation

◆ internalVarsToExport

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

◆ mapper

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

protected

Mapper.

Definition at line 83 of file poiexportmodule.h.

Referenced by giveMapper().

◆ mtype

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

protected

Referenced by giveMapper(), and initializeFrom().

◆ POIList

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

◆ primaryVarsToExport

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:

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ POIEM_MapperType

Constructor & Destructor Documentation

◆ POIExportModule()

◆ ~POIExportModule()

Member Function Documentation

◆ doOutput()

◆ exportIntVarAs()

◆ exportIntVars()

◆ exportPrimaryVars()

◆ exportPrimVarAs()

◆ giveClassName()

◆ giveInputRecordName()

◆ giveMapper()

◆ giveOutputStream()

◆ initialize()

◆ initializeFrom()

◆ readPOIFile()

◆ terminate()

Member Data Documentation

◆ internalVarsToExport

◆ mapper

◆ mtype

◆ POIList

◆ primaryVarsToExport