oofem::SolutionStatusExportModule Class Reference

#include <solutionstatusexportmodule.h>

Inheritance diagram for oofem::SolutionStatusExportModule:

Collaboration diagram for oofem::SolutionStatusExportModule:

Public Member Functions
	SolutionStatusExportModule (int n, EngngModel *e, FILE *out=nullptr)
	SolutionStatusExportModule (const SolutionStatusExportModule &)=delete
SolutionStatusExportModule &	operator= (const SolutionStatusExportModule &)=delete
void	initialize () override
void	terminate () override
void	initializeFrom (InputRecord &ir) override
	Initializes receiver according to object description stored in input record.
void	doOutput (TimeStep *tStep, bool forcedOutput=false) 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
void	checkRecs ()
void	printRecsHeader ()
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
std::string	filename
FILE *	outputFile
std::vector< std::string >	recs
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

Configurable solution status export module. Creates and continuously updates the status file according to simulation progress.

Definition at line 56 of file solutionstatusexportmodule.h.

Constructor & Destructor Documentation

SolutionStatusExportModule() [1/2]

oofem::SolutionStatusExportModule::SolutionStatusExportModule	(	int	n,
		EngngModel *	e,
		FILE *	out = nullptr )

Referenced by operator=(), and SolutionStatusExportModule().

SolutionStatusExportModule() [2/2]

oofem::SolutionStatusExportModule::SolutionStatusExportModule ( const SolutionStatusExportModule & )

delete

References SolutionStatusExportModule().

Member Function Documentation

checkRecs()

void oofem::SolutionStatusExportModule::checkRecs ( )

protected

Definition at line 158 of file solutionstatusexportmodule.C.

References OOFEM_WARNING, and recs.

Referenced by initializeFrom().

doOutput()

void oofem::SolutionStatusExportModule::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 72 of file solutionstatusexportmodule.C.

References oofem::TimeStep::convergedReason, oofem::CR_CONVERGED, oofem::CR_DIVERGED_ITS, oofem::CR_DIVERGED_TOL, oofem::CR_FAILED, oofem::TimeStep::giveMetaStepNumber(), oofem::TimeStep::giveNumber(), oofem::TimeStep::giveTargetTime(), oofem::TimeStep::giveTimeIncrement(), oofem::TimeStep::numberOfAttempts, oofem::TimeStep::numberOfIterations, outputFile, recs, oofem::TimeStep::solutionTime, and oofem::ExportModule::testTimeStepOutput().

Referenced by operator=().

giveClassName()

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

inlineoverridevirtual

Returns class name of the receiver.

Implements oofem::ExportModule.

Definition at line 75 of file solutionstatusexportmodule.h.

giveInputRecordName()

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

inline

Definition at line 76 of file solutionstatusexportmodule.h.

References _IFT_SolutionStatusExportModule_Name.

initialize()

void oofem::SolutionStatusExportModule::initialize ( )

overridevirtual

Reimplemented from oofem::ExportModule.

Definition at line 121 of file solutionstatusexportmodule.C.

References oofem::ExportModule::emodel, filename, HOST_TYPE, initialize(), MODULE_LIST, OOFEM_GIT_HASH, outputFile, PRG_VERSION, and printRecsHeader().

Referenced by initialize(), and operator=().

initializeFrom()

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

overridevirtual

Initializes receiver according to object description stored in input record.

Reimplemented from oofem::ExportModule.

Definition at line 55 of file solutionstatusexportmodule.C.

References _IFT_SolutionStatusExportModule_format, checkRecs(), IR_GIVE_OPTIONAL_FIELD, and recs.

Referenced by operator=().

operator=()

SolutionStatusExportModule & oofem::SolutionStatusExportModule::operator= ( const SolutionStatusExportModule & )

delete

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

printRecsHeader()

void oofem::SolutionStatusExportModule::printRecsHeader ( )

protected

Definition at line 174 of file solutionstatusexportmodule.C.

References outputFile, and recs.

Referenced by initialize().

terminate()

void oofem::SolutionStatusExportModule::terminate ( )

overridevirtual

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

Reimplemented from oofem::ExportModule.

Definition at line 137 of file solutionstatusexportmodule.C.

References oofem::ExportModule::emodel, oofem::oofem_logger, outputFile, and terminate().

Referenced by operator=(), and terminate().

Member Data Documentation

filename

std::string oofem::SolutionStatusExportModule::filename

protected

Definition at line 59 of file solutionstatusexportmodule.h.

Referenced by initialize().

outputFile

FILE* oofem::SolutionStatusExportModule::outputFile

protected

Definition at line 60 of file solutionstatusexportmodule.h.

Referenced by doOutput(), initialize(), printRecsHeader(), and terminate().

recs

std::vector<std::string> oofem::SolutionStatusExportModule::recs

protected

Definition at line 61 of file solutionstatusexportmodule.h.

Referenced by checkRecs(), doOutput(), initializeFrom(), and printRecsHeader().

---

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

• solutionstatusexportmodule.h
• solutionstatusexportmodule.C