oofem::UserDefDirichletBC Class Reference

#include <userdefdirichletbc.h>

Inheritance diagram for oofem::UserDefDirichletBC:

Collaboration diagram for oofem::UserDefDirichletBC:

Public Member Functions
	UserDefDirichletBC (int i, Domain *d)
virtual	~UserDefDirichletBC ()
	Destructor.
double	give (Dof *dof, ValueModeType mode, double time) override
bcType	giveType () const override
void	initializeFrom (InputRecord &ir) override
void	giveInputRecord (DynamicInputRecord &input) override
void	scale (double s) override
const char *	giveClassName () const override
const char *	giveInputRecordName () const override
Public Member Functions inherited from oofem::BoundaryCondition
	BoundaryCondition (int i, Domain *d)
virtual	~BoundaryCondition ()
	Destructor.
virtual double	give (Dof *dof, ValueModeType mode, TimeStep *tStep)
void	setPrescribedValue (double s)
void	saveContext (DataStream &stream, ContextMode mode) override
void	restoreContext (DataStream &stream, ContextMode mode) override
Public Member Functions inherited from oofem::GeneralBoundaryCondition
	GeneralBoundaryCondition (int n, Domain *d)
virtual	~GeneralBoundaryCondition ()
	Destructor.
int	giveSetNumber () const
virtual int	giveNumberOfInternalDofManagers ()
	Gives the number of internal dof managers.
virtual DofManager *	giveInternalDofManager (int i)
	Gives an internal dof manager from receiver.
Function *	giveTimeFunction ()
int	getIsImposedTimeFunctionNumber () const
void	setIsImposedTimeFunctionNumber (int funcIndx)
virtual bcValType	giveBCValType () const
virtual bool	isImposed (TimeStep *tStep)
virtual const IntArray &	giveDofIDs () const
virtual bcGeomType	giveBCGeoType () const
virtual double	giveProperty (int aProperty, TimeStep *tStep) const
void	saveContext (DataStream &stream, ContextMode mode) override
void	restoreContext (DataStream &stream, ContextMode mode) override
virtual void	updateYourself (TimeStep *tStep)
Public Member Functions inherited from oofem::FEMComponent
	FEMComponent (int n, Domain *d)
virtual	~FEMComponent ()=default
	Virtual destructor.
Domain *	giveDomain () const
virtual void	setDomain (Domain *d)
int	giveNumber () const
void	setNumber (int num)
virtual void	updateLocalNumbering (EntityRenumberingFunctor &f)
virtual void	initializeFrom (InputRecord &ir, int priority)
virtual void	initializeFinish ()
virtual void	postInitialize ()
	Performs post initialization steps. Called after all components are created and initialized.
virtual int	checkConsistency ()
virtual void	printOutputAt (FILE *file, TimeStep *tStep)
virtual void	printYourself ()
	Prints receiver state on stdout. Useful for debugging.
virtual Interface *	giveInterface (InterfaceType t)
std::string	errorInfo (const char *func) const
	Returns string for prepending output (used by error reporting macros).

Protected Attributes
FloatArray	values
	Prescribed values for each resp. dof.
PyObject *	mpModule
PyObject *	mpFunc
std::string	mFileName
Protected Attributes inherited from oofem::BoundaryCondition
FloatArray	values
	Prescribed values for each resp. dof.
Protected Attributes inherited from oofem::GeneralBoundaryCondition
int	timeFunction
	Associated load time function.
bcValType	valType
	Physical meaning of BC value.
IntArray	dofs
	Dofs that b.c. is applied to (relevant for Dirichlet type b.c.s).
int	isImposedTimeFunction
int	set
	Set number for boundary condition to be applied to.
Protected Attributes inherited from oofem::FEMComponent
int	number
	Component number.
Domain *	domain
	Link to domain object, useful for communicating with other FEM components.

Detailed Description

Definition at line 75 of file userdefdirichletbc.h.

Constructor & Destructor Documentation

UserDefDirichletBC()

oofem::UserDefDirichletBC::UserDefDirichletBC	(	int	i,
		Domain *	d )

Constructor. Creates boundary condition with given number, belonging to given domain.

Parameters

i	Boundary condition number.
d	Domain to which new object will belongs.

Definition at line 52 of file userdefdirichletbc.C.

References oofem::BoundaryCondition::BoundaryCondition(), and mpModule.

~UserDefDirichletBC()

oofem::UserDefDirichletBC::~UserDefDirichletBC ( )

virtual

Destructor.

Definition at line 56 of file userdefdirichletbc.C.

References mpModule.

Member Function Documentation

give()

double oofem::UserDefDirichletBC::give ( Dof * dof, ValueModeType mode, double time )

overridevirtual

Reimplemented from oofem::BoundaryCondition.

Definition at line 63 of file userdefdirichletbc.C.

References oofem::DofManager::giveCoordinate(), oofem::DofManager::giveCoordinates(), oofem::Dof::giveDofID(), oofem::Dof::giveDofManager(), oofem::FloatArray::giveSize(), oofem::GeneralBoundaryCondition::giveTimeFunction(), mpFunc, and OOFEM_ERROR.

giveClassName()

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

inlineoverridevirtual

Returns

Class name of the receiver.

Reimplemented from oofem::BoundaryCondition.

Definition at line 103 of file userdefdirichletbc.h.

giveInputRecord()

void oofem::UserDefDirichletBC::giveInputRecord ( DynamicInputRecord & input )

overridevirtual

Setups the input record string of receiver.

Parameters

input

Dynamic input record to be filled by receiver.

Reimplemented from oofem::BoundaryCondition.

Definition at line 158 of file userdefdirichletbc.C.

References _IFT_UserDefDirichletBC_filename, mFileName, and oofem::DynamicInputRecord::setField().

giveInputRecordName()

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

inlineoverridevirtual

Returns

Input record name of the receiver.

Reimplemented from oofem::BoundaryCondition.

Definition at line 104 of file userdefdirichletbc.h.

References _IFT_UserDefDirichletBC_Name.

giveType()

bcType oofem::UserDefDirichletBC::giveType ( ) const

inlineoverridevirtual

Returns

Type of boundary condition. It allows to distinguish BC according its mathematical meaning, ie. like Dirichlet, Neumann, or Newton type.

Reimplemented from oofem::BoundaryCondition.

Definition at line 99 of file userdefdirichletbc.h.

References oofem::DirichletBT.

initializeFrom()

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

overridevirtual

Initializes receiver according to object description stored in input record. This function is called immediately after creating object using constructor. Input record can be imagined as data record in component database belonging to receiver. Receiver may use value-name extracting functions to extract particular field from record. Note that initializeFrom may be called mutiple times.

See also

IR_GIVE_FIELD

IR_GIVE_OPTIONAL_FIELD

Parameters

ir	Input record to initialize from.
priority	Priority of the input record. This is used to determine the order of initialization

Reimplemented from oofem::BoundaryCondition.

Definition at line 132 of file userdefdirichletbc.C.

References _IFT_UserDefDirichletBC_filename, IR_GIVE_FIELD, mFileName, mpFunc, and mpModule.

scale()

void oofem::UserDefDirichletBC::scale ( double s )

overridevirtual

Scales the receiver according to given value. Typically used in nondimensional analysis to scale down BCs and ICs.

Parameters

s	Scale factor.

Reimplemented from oofem::BoundaryCondition.

Definition at line 166 of file userdefdirichletbc.C.

References values.

Member Data Documentation

mFileName

std::string oofem::UserDefDirichletBC::mFileName

protected

Definition at line 84 of file userdefdirichletbc.h.

Referenced by giveInputRecord(), and initializeFrom().

mpFunc

PyObject* oofem::UserDefDirichletBC::mpFunc

protected

Definition at line 82 of file userdefdirichletbc.h.

Referenced by give(), and initializeFrom().

mpModule

PyObject* oofem::UserDefDirichletBC::mpModule

protected

Definition at line 81 of file userdefdirichletbc.h.

Referenced by initializeFrom(), UserDefDirichletBC(), and ~UserDefDirichletBC().

values

FloatArray oofem::UserDefDirichletBC::values

protected

Prescribed values for each resp. dof.

Definition at line 79 of file userdefdirichletbc.h.

Referenced by scale().

---

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

• userdefdirichletbc.h
• userdefdirichletbc.C