oofem::InitModule Class Reference

Represents init module - a base class for all init modules. More...

#include <initmodule.h>

Inheritance diagram for oofem::InitModule:

Collaboration diagram for oofem::InitModule:

Public Member Functions
	InitModule (int n, EngngModel *e)
	Constructor. Creates empty Init Module with number n. More...
virtual	~InitModule ()
	Destructor. More...
virtual IRResultType	initializeFrom (InputRecord *ir)=0
	Initializes receiver according to object description stored in input record. More...
virtual void	doInit ()=0
	Reads the input. Abstract service. More...
virtual const char *	giveClassName () const
	Returns class name of the receiver. More...
std::string	errorInfo (const char *func) const
	Error printing helper. More...

Protected Attributes
int	number
	Number. More...
EngngModel *	emodel
	Problem pointer. More...
FILE *	initStream
	Initialization file. More...

Detailed Description

Represents init module - a base class for all init modules.

InitModule is an abstraction for module performing some specific kind of initialization. The modules can declare necessary component services using the interface concept. The basic class declares the basic services (the general interface). The initialization modules are maintained by InitModuleManager. The initialization for is done only once, at simulation startup by one of above described method.

Definition at line 61 of file initmodule.h.

Constructor & Destructor Documentation

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

Constructor. Creates empty Init Module with number n.

Definition at line 39 of file initmodule.C.

References emodel, and number.

oofem::InitModule::~InitModule ( )

virtual

Destructor.

Definition at line 46 of file initmodule.C.

Member Function Documentation

virtual void oofem::InitModule::doInit ( )

pure virtual

Reads the input. Abstract service.

Implemented in oofem::GPInitModule.

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

inline

Error printing helper.

Definition at line 83 of file initmodule.h.

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

inlinevirtual

Returns class name of the receiver.

Reimplemented in oofem::GPInitModule.

Definition at line 81 of file initmodule.h.

IRResultType oofem::InitModule::initializeFrom ( InputRecord *  ir )

pure virtual

Initializes receiver according to object description stored in input record.

Implemented in oofem::GPInitModule.

Definition at line 51 of file initmodule.C.

References _IFT_InitModule_initfilename, initStream, IR_GIVE_FIELD, oofem::IRRT_OK, and OOFEM_ERROR.

Referenced by oofem::GPInitModule::initializeFrom().

Member Data Documentation

EngngModel* oofem::InitModule::emodel

protected

Problem pointer.

Definition at line 67 of file initmodule.h.

Referenced by oofem::GPInitModule::doInit(), and InitModule().

FILE* oofem::InitModule::initStream

protected

Initialization file.

Definition at line 69 of file initmodule.h.

Referenced by oofem::GPInitModule::doInit(), and initializeFrom().

int oofem::InitModule::number

protected

Number.

Definition at line 65 of file initmodule.h.

Referenced by InitModule().

---

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

• initmodule.h
• initmodule.C