Abstract base class for all boundary conditions of problem. More...

#include <generalboundarycondition.h>

Inheritance diagram for oofem::GeneralBoundaryCondition:

Collaboration diagram for oofem::GeneralBoundaryCondition:

Public Member Functions
	GeneralBoundaryCondition (int n, Domain *d)
	Constructor. More...

virtual	~GeneralBoundaryCondition ()
	Destructor. More...

int	giveSetNumber ()
	Gives the set number which boundary condition is applied to. More...

virtual int	giveNumberOfInternalDofManagers ()
	Gives the number of internal dof managers. More...

virtual DofManager *	giveInternalDofManager (int i)
	Gives an internal dof manager from receiver. More...

Function *	giveTimeFunction ()

virtual bcValType	giveBCValType () const
	Returns receiver load type. More...

virtual bool	isImposed (TimeStep *tStep)
	Returns nonzero if receiver representing BC is imposed at given time, otherwise returns zero. More...

virtual const IntArray &	giveDofIDs () const
	Array with default dofs which b.c. More...

virtual bcType	giveType () const

virtual bcGeomType	giveBCGeoType () const
	Returns geometry character of boundary condition. More...

virtual void	scale (double s)
	Scales the receiver according to given value. More...

virtual void	postInitialize ()
	Performs post initialization steps. More...

virtual IRResultType	initializeFrom (InputRecord *ir)
	Initializes receiver according to object description stored in input record. More...

virtual void	giveInputRecord (DynamicInputRecord &input)
	Setups the input record string of receiver. More...

virtual contextIOResultType	saveContext (DataStream &stream, ContextMode mode, void *obj=NULL)
	Stores receiver state to output stream. More...

virtual contextIOResultType	restoreContext (DataStream &stream, ContextMode mode, void *obj=NULL)
	Restores the receiver state previously written in stream. More...

Public Member Functions inherited from oofem::FEMComponent
	FEMComponent (int n, Domain *d)
	Regular constructor, creates component with given number and belonging to given domain. More...

virtual	~FEMComponent ()
	Virtual destructor. More...

virtual const char *	giveClassName () const =0

virtual const char *	giveInputRecordName () const =0

Domain *	giveDomain () const

virtual void	setDomain (Domain *d)
	Sets associated Domain. More...

int	giveNumber () const

void	setNumber (int num)
	Sets number of receiver. More...

virtual void	updateLocalNumbering (EntityRenumberingFunctor &f)
	Local renumbering support. More...

virtual int	checkConsistency ()
	Allows programmer to test some internal data, before computation begins. More...

virtual void	printOutputAt (FILE file, TimeStep tStep)
	Prints output of receiver to stream, for given time step. More...

virtual void	printYourself ()
	Prints receiver state on stdout. Useful for debugging. More...

virtual Interface *	giveInterface (InterfaceType t)
	Interface requesting service. More...

std::string	errorInfo (const char *func) const
	Returns string for prepending output (used by error reporting macros). More...

Protected Attributes
int	timeFunction
	Associated load time function. More...

bcValType	valType
	Physical meaning of BC value. More...

IntArray	dofs
	Dofs that b.c. is applied to (relevant for Dirichlet type b.c.s). More...

int	isImposedTimeFunction
	Zero by default - the BC is than always imposed. More...

int	set
	Set number for boundary condition to be applied to. More...

Protected Attributes inherited from oofem::FEMComponent
int	number
	Component number. More...

Domain *	domain
	Link to domain object, useful for communicating with other FEM components. More...

Detailed Description

Abstract base class for all boundary conditions of problem.

Boundary condition is an attribute of the domain (it belongs to). General BC is also attribute of several elements, nodes, Dofs and so on, which are subjected to boundary condition.

This base class only declares itself as a base class of all boundary conditions, and declares only very basic services. This base class introduces 'TimeFunction' as an attribute of each boundary condition. 'TimeFunction' represent time variation, its value is dependent on time step. The value (or the components) of a boundary condition (load) will be the product of its value by the value of the associated load time function at given time step. The meaning of boundary condition components is dependent on particular boundary condition type, and should be defined in derived classes documentation.

This base class introduces also two general services for requesting boundary condition physical meaning and boundary condition geometrical character (pointwise, acting on element body or edge and so on).

Derived classes should represent the base classes for particular boundary condition type (like force load, or boundary condition prescribed directly on some dof) and should declare the basic common interface.

Definition at line 81 of file generalboundarycondition.h.

Constructor & Destructor Documentation

oofem::GeneralBoundaryCondition::GeneralBoundaryCondition	(	int	n,
		Domain *	d
	)

Constructor.

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

Parameters

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

Definition at line 45 of file generalboundarycondition.C.

References isImposedTimeFunction, and timeFunction.

virtual oofem::GeneralBoundaryCondition::~GeneralBoundaryCondition ( )

inlinevirtual

Destructor.

Definition at line 106 of file generalboundarycondition.h.

Member Function Documentation

virtual bcGeomType oofem::GeneralBoundaryCondition::giveBCGeoType ( ) const

inlinevirtual

Returns geometry character of boundary condition.

For available values see cltypes.h file. Derived classes should always overload, default implementation returns UnknownLoadGT value.

Reimplemented in oofem::PointLoad, oofem::NodalLoad, oofem::NeumannMomentLoad, oofem::ConstantSurfaceLoad, oofem::ConstantPressureLoad, oofem::LinearEdgeLoad, oofem::Reinforcement, oofem::InteractionLoad, oofem::GravityPressure, oofem::ConstantEdgeLoad, oofem::StructuralEigenstrainLoad, oofem::DeadWeight, oofem::BodyLoad, and oofem::StructuralTemperatureLoad.

Definition at line 153 of file generalboundarycondition.h.

References oofem::UnknownBGT.

virtual bcValType oofem::GeneralBoundaryCondition::giveBCValType ( ) const

inlinevirtual

Returns receiver load type.

It distinguish particular boundary conditions according to their "physical" meaning (like StructuralTemperatureLoadLT, StructuralLoadLT). Derived classes should always overload, default implementation returns UnknownLT value. See cltypes.h file for details.

Reimplemented in oofem::Reinforcement, oofem::StructuralEigenstrainLoad, oofem::DeadWeight, and oofem::StructuralTemperatureLoad.

Definition at line 130 of file generalboundarycondition.h.

virtual const IntArray& oofem::GeneralBoundaryCondition::giveDofIDs ( ) const

inlinevirtual

Array with default dofs which b.c.

acts on (only Dirichlet type b.c.s are afflicted).

Returns: Array with dof IDs.

Definition at line 143 of file generalboundarycondition.h.

Referenced by oofem::DofDistributedPrimaryField::applyBoundaryCondition(), oofem::PrimaryField::applyBoundaryCondition(), oofem::EngngModel::assembleVectorFromBC(), oofem::EngngModel::assembleVectorFromDofManagers(), oofem::Node::computeLoadVector(), oofem::DofManager::computeLoadVector(), oofem::Domain::createDofs(), giveInputRecord(), and oofem::IncrementalLinearStatic::solveYourselfAt().

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

virtual

Setups the input record string of receiver.

Parameters

input Dynamic input record to be filled by receiver.

Reimplemented from oofem::FEMComponent.

Reimplemented in oofem::Load, oofem::BoundaryLoad, oofem::MixedGradientPressureNeumann, oofem::MixedGradientPressureDirichlet, oofem::PrescribedGradientBCWeak, oofem::BoundaryCondition, oofem::MixedGradientPressureWeakPeriodic, oofem::PrescribedGenStrainShell7, oofem::UserDefDirichletBC, oofem::TransportGradientDirichlet, oofem::PrescribedGenStrainShell7, oofem::PointLoad, oofem::NodalLoad, oofem::TransportGradientPeriodic, oofem::PrescribedGradient, oofem::ConstantSurfaceLoad, oofem::ConstantPressureLoad, oofem::PrescribedGradientBCPeriodic, oofem::LinearEdgeLoad, oofem::RotatingBoundary, oofem::InteractionLoad, oofem::TransportGradientNeumann, and oofem::PrescribedGradientBCNeumann.

Definition at line 108 of file generalboundarycondition.C.

References _IFT_GeneralBoundaryCondition_dofs, _IFT_GeneralBoundaryCondition_isImposedTimeFunct, _IFT_GeneralBoundaryCondition_set, _IFT_GeneralBoundaryCondition_timeFunct, _IFT_GeneralBoundaryCondition_valType, giveBCValType(), giveDofIDs(), oofem::FEMComponent::giveInputRecord(), giveSetNumber(), isImposedTimeFunction, oofem::DynamicInputRecord::setField(), and timeFunction.

virtual DofManager* oofem::GeneralBoundaryCondition::giveInternalDofManager ( int i )

inlinevirtual

Gives an internal dof manager from receiver.

Reimplemented in oofem::WeakPeriodicBoundaryCondition, oofem::SolutionbasedShapeFunction, oofem::MixedGradientPressureNeumann, oofem::PrescribedGradientBCWeak, oofem::MixedGradientPressureDirichlet, oofem::LinearConstraintBC, oofem::MixedGradientPressureWeakPeriodic, oofem::PrescribedMean, oofem::TransportGradientPeriodic, oofem::PrescribedGradientBCPeriodic, oofem::TransportGradientNeumann, and oofem::PrescribedGradientBCNeumann.

Definition at line 116 of file generalboundarycondition.h.

Referenced by oofem::DofDistributedPrimaryField::applyBoundaryCondition(), oofem::IncrementalLinearStatic::solveYourselfAt(), and oofem::StructuralEngngModel::updateInternalState().

virtual int oofem::GeneralBoundaryCondition::giveNumberOfInternalDofManagers ( )

inlinevirtual

Gives the number of internal dof managers.

Reimplemented in oofem::WeakPeriodicBoundaryCondition, oofem::SolutionbasedShapeFunction, oofem::MixedGradientPressureNeumann, oofem::PrescribedGradientBCWeak, oofem::MixedGradientPressureDirichlet, oofem::LinearConstraintBC, oofem::MixedGradientPressureWeakPeriodic, oofem::PrescribedMean, oofem::TransportGradientPeriodic, oofem::PrescribedGradientBCPeriodic, oofem::TransportGradientNeumann, and oofem::PrescribedGradientBCNeumann.

Definition at line 114 of file generalboundarycondition.h.

Referenced by oofem::StaticStructural::requiresEquationRenumbering(), oofem::TransientTransportProblem::requiresEquationRenumbering(), oofem::IncrementalLinearStatic::solveYourselfAt(), and oofem::StructuralEngngModel::updateInternalState().

int oofem::GeneralBoundaryCondition::giveSetNumber ( )

inline

Gives the set number which boundary condition is applied to.

Definition at line 111 of file generalboundarycondition.h.

Referenced by oofem::DofDistributedPrimaryField::applyBoundaryCondition(), oofem::PrimaryField::applyBoundaryCondition(), oofem::PrescribedGradientBCNeumann::assembleVector(), oofem::EngngModel::assembleVectorFromBC(), oofem::PrescribedGradient::computeField(), oofem::StructuralElement::computeResultingIPEigenstrainAt(), oofem::StructuralElement::computeResultingIPTemperatureAt(), oofem::PrescribedGradientBCNeumann::computeTangent(), oofem::PrescribedGradient::computeTangent(), oofem::Domain::createDofs(), giveInputRecord(), oofem::BCTracker::initialize(), oofem::SolutionbasedShapeFunction::initializeSurfaceData(), and oofem::IncrementalLinearStatic::solveYourselfAt().

Function * oofem::GeneralBoundaryCondition::giveTimeFunction ( )

Returns: Associated load time function of receiver.

Definition at line 53 of file generalboundarycondition.C.

References oofem::FEMComponent::domain, oofem::Domain::giveFunction(), OOFEM_ERROR, and timeFunction.

Referenced by oofem::PrescribedGradientBCNeumann::assembleVector(), oofem::TransportGradientNeumann::assembleVector(), oofem::Load::computeComponentArrayAt(), oofem::PrescribedGradientBCWeak::computeExtForceElContrib(), oofem::ConstantEdgeLoad::computeValueAt(), oofem::InteractionLoad::computeValueAt(), oofem::ConstantPressureLoad::computeValueAt(), oofem::ConstantSurfaceLoad::computeValueAt(), oofem::NeumannMomentLoad::computeValueAt(), oofem::PointLoad::computeValueAt(), oofem::BoundaryLoad::computeValueAt(), oofem::NeumannMomentLoad::computeValueAtBoundary(), oofem::PrescribedGradient::give(), oofem::RotatingBoundary::give(), oofem::PrescribedGenStrainShell7::give(), oofem::UserDefDirichletBC::give(), oofem::TransportGradientDirichlet::give(), oofem::BoundaryCondition::give(), oofem::PrescribedGradientBCPeriodic::giveBcValue(), oofem::TransportGradientPeriodic::giveBcValue(), oofem::PrescribedMean::giveExternalForcesVector(), oofem::WeakPeriodicBoundaryCondition::giveExternalForcesVector(), oofem::PrescribedGradientBCPeriodic::giveUnknown(), oofem::TransportGradientPeriodic::giveUnknown(), oofem::GnuplotExportModule::outputBoundaryCondition(), and oofem::GnuplotExportModule::outputGradient().

virtual bcType oofem::GeneralBoundaryCondition::giveType ( ) const

inlinevirtual

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

Reimplemented in oofem::BoundaryLoad, oofem::MixedGradientPressureNeumann, oofem::PrescribedGradientBCWeak, oofem::BoundaryCondition, oofem::MixedGradientPressureWeakPeriodic, oofem::TransportGradientDirichlet, oofem::UserDefDirichletBC, oofem::PointLoad, oofem::PrescribedGenStrainShell7, oofem::PrescribedGenStrainShell7, oofem::PrescribedGradient, oofem::TransportGradientNeumann, oofem::MixedGradientPressureBC, and oofem::PrescribedGradientBCNeumann.

Definition at line 148 of file generalboundarycondition.h.

References oofem::UnknownBT.

Referenced by oofem::TR1_2D_SUPG_AXI::computeBCLhsPressureTerm_MB(), oofem::SUPGElement::computeBCLhsPressureTerm_MB(), oofem::TR1_2D_SUPG_AXI::computeBCLhsTerm_MB(), oofem::SUPGElement::computeBCLhsTerm_MB(), oofem::TransportElement::computeBCSubMtrxAt(), oofem::Tr1Darcy::computeEdgeBCSubVectorAt(), oofem::TR1_2D_PFEM::computeEdgeBCSubVectorAt(), oofem::TransportElement::computeEdgeBCSubVectorAt(), oofem::TransportElement::computeLoadVector(), oofem::TransportElement::computeSurfaceBCSubVectorAt(), and oofem::MasterDof::giveBc().

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

virtual

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.

See also: IR_GIVE_FIELD; IR_GIVE_OPTIONAL_FIELD

Parameters

ir	Input record to initialize from.

Returns: IRResultType

Reimplemented from oofem::FEMComponent.

Reimplemented in oofem::Load, oofem::WeakPeriodicBoundaryCondition, oofem::BoundaryLoad, oofem::MixedGradientPressureNeumann, oofem::SolutionbasedShapeFunction, oofem::MixedGradientPressureDirichlet, oofem::PrescribedGradientBCWeak, oofem::BoundaryCondition, oofem::MixedGradientPressureWeakPeriodic, oofem::PrescribedGenStrainShell7, oofem::UserDefDirichletBC, oofem::LinearConstraintBC, oofem::TransportGradientDirichlet, oofem::PrescribedGenStrainShell7, oofem::PointLoad, oofem::UserDefinedTemperatureField, oofem::NodalLoad, oofem::NeumannMomentLoad, oofem::ForeignTemperatureFieldLoad, oofem::TransportGradientPeriodic, oofem::PrescribedGradient, oofem::ConstantSurfaceLoad, oofem::MixedGradientPressureBC, oofem::Reinforcement, oofem::ConstantPressureLoad, oofem::PrescribedMean, oofem::PrescribedGradientBCPeriodic, oofem::LinearEdgeLoad, oofem::RotatingBoundary, oofem::GravityPressure, oofem::ActiveBoundaryCondition, oofem::InteractionLoad, oofem::SurfaceTensionBoundaryCondition, oofem::TransportGradientNeumann, oofem::ConstantEdgeLoad, oofem::PrescribedGradientBCNeumann, oofem::TF1, oofem::PrescribedGradientBCWeakDirichlet, and oofem::PrescribedGradientBCWeakPeriodic.

Definition at line 66 of file generalboundarycondition.C.

References _IFT_GeneralBoundaryCondition_dofs, _IFT_GeneralBoundaryCondition_isImposedTimeFunct, _IFT_GeneralBoundaryCondition_set, _IFT_GeneralBoundaryCondition_timeFunct, _IFT_GeneralBoundaryCondition_valType, oofem::IntArray::clear(), dofs, IR_GIVE_FIELD, IR_GIVE_OPTIONAL_FIELD, oofem::IRRT_BAD_FORMAT, oofem::IRRT_OK, isImposedTimeFunction, OOFEM_WARNING, timeFunction, and valType.

bool oofem::GeneralBoundaryCondition::isImposed ( TimeStep * tStep )

virtual

Returns nonzero if receiver representing BC is imposed at given time, otherwise returns zero.

Parameters

tStep Time step representing time when receiver is tested.

Returns: True if imposed for given time, false otherwise.

Definition at line 92 of file generalboundarycondition.C.

References oofem::FEMComponent::domain, oofem::Function::evaluateAtTime(), oofem::Domain::giveFunction(), oofem::TimeStep::giveIntrinsicTime(), and isImposedTimeFunction.

Referenced by oofem::DofDistributedPrimaryField::applyBoundaryCondition(), oofem::LinearConstraintBC::assemble(), oofem::EngngModel::assembleVectorFromBC(), oofem::TransportElement::computeBCSubMtrxAt(), oofem::TransportElement::computeBCSubVectorAt(), oofem::TransportElement::computeBoundaryEdgeLoadVector(), oofem::Load::computeComponentArrayAt(), oofem::BeamBaseElement::computeLocalForceLoadVector(), oofem::StructuralElement::computeResultingIPEigenstrainAt(), oofem::StructuralElement::computeResultingIPTemperatureAt(), oofem::ConstantEdgeLoad::computeValueAt(), oofem::Beam3d::giveInternalForcesVectorAtPoint(), oofem::MasterDof::hasBc(), and oofem::IncrementalLinearStatic::solveYourselfAt().

virtual void oofem::GeneralBoundaryCondition::postInitialize ( )

inlinevirtual

Performs post initialization steps.

Reimplemented in oofem::PrescribedGradientBCWeak, oofem::TransportGradientDirichlet, oofem::TransportGradientPeriodic, oofem::PrescribedGradientBCPeriodic, oofem::TransportGradientNeumann, oofem::PrescribedGradientBCWeakDirichlet, and oofem::PrescribedGradientBCWeakPeriodic.

Definition at line 162 of file generalboundarycondition.h.

Referenced by oofem::TransportGradientNeumann::postInitialize(), and oofem::TransportGradientDirichlet::postInitialize().

contextIOResultType oofem::GeneralBoundaryCondition::restoreContext	(	DataStream &	stream,
		ContextMode	mode,
		void *	obj = `NULL`
	)

virtual

Restores the receiver state previously written in stream.

See also: saveContext

Parameters

stream	Input stream.
mode	Determines amount of info available in stream (state, definition, ...).
obj	Special parameter for sending extra information.

Returns: contextIOResultType.

Exceptions

throws an ContextIOERR exception if error encountered.

Reimplemented from oofem::FEMComponent.

Reimplemented in oofem::BoundaryCondition, and oofem::LinearConstraintBC.

Definition at line 144 of file generalboundarycondition.C.

References oofem::CIO_IOERR, oofem::CIO_OK, CM_Definition, oofem::DataStream::read(), THROW_CIOERR, and timeFunction.

Referenced by oofem::BoundaryCondition::restoreContext().

contextIOResultType oofem::GeneralBoundaryCondition::saveContext	(	DataStream &	stream,
		ContextMode	mode,
		void *	obj = `NULL`
	)

virtual

Stores receiver state to output stream.

Parameters

stream	Output stream.
mode	Determines amount of info required in stream (state, definition, ...).
obj	Special parameter, used only to send particular integration point to material class version of this method.