OOFEM 3.0
Loading...
Searching...
No Matches
oofem::ActiveBoundaryCondition Class Reference

#include <activebc.h>

Inheritance diagram for oofem::ActiveBoundaryCondition:
Collaboration diagram for oofem::ActiveBoundaryCondition:

Public Member Functions

 ActiveBoundaryCondition (int n, Domain *d)
virtual ~ActiveBoundaryCondition ()
 Destructor.
void initializeFrom (InputRecord &ir) override
Methods supporting classical input files.
virtual void addElementSide (int elem, int side)
virtual void assemble (SparseMtrx &answer, TimeStep *tStep, CharType type, const UnknownNumberingScheme &r_s, const UnknownNumberingScheme &c_s, double scale=1.0, void *lock=nullptr)
virtual void assembleVector (FloatArray &answer, TimeStep *tStep, CharType type, ValueModeType mode, const UnknownNumberingScheme &s, FloatArray *eNorms=nullptr, void *lock=nullptr)
virtual void giveLocationArrays (std ::vector< IntArray > &rows, std ::vector< IntArray > &cols, CharType type, const UnknownNumberingScheme &r_s, const UnknownNumberingScheme &c_s)
Functions related to boundary conditions which have to deal with special slave DOFs.

Boundary conditions that do not require slave dofs do not need to overload these functions.

See also
ActiveDof The active DOF passes these functions here.
virtual bool requiresActiveDofs ()
virtual bool isPrimaryDof (ActiveDof *dof)
virtual double giveBcValue (Dof *dof, ValueModeType mode, TimeStep *tStep)
virtual bool hasBc (Dof *dof, TimeStep *tStep)
virtual int giveNumberOfMasterDofs (ActiveDof *dof)
virtual DofgiveMasterDof (ActiveDof *dof, int mdof)
virtual void computeDofTransformation (ActiveDof *dof, FloatArray &masterContribs)
virtual double giveUnknown (PrimaryField &field, ValueModeType mode, TimeStep *tStep, ActiveDof *dof)
virtual double giveUnknown (ValueModeType mode, TimeStep *tStep, ActiveDof *dof)
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 DofManagergiveInternalDofManager (int i)
 Gives an internal dof manager from receiver.
FunctiongiveTimeFunction ()
int getIsImposedTimeFunctionNumber () const
void setIsImposedTimeFunctionNumber (int funcIndx)
virtual bcValType giveBCValType () const
virtual bool isImposed (TimeStep *tStep)
virtual const IntArraygiveDofIDs () const
virtual bcType giveType () const
virtual bcGeomType giveBCGeoType () const
virtual void scale (double s)
virtual double giveProperty (int aProperty, TimeStep *tStep) const
void initializeFrom (InputRecord &ir) override
void giveInputRecord (DynamicInputRecord &input) override
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.
virtual const char * giveClassName () const =0
virtual const char * giveInputRecordName () const =0
DomaingiveDomain () 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 InterfacegiveInterface (InterfaceType t)
std::string errorInfo (const char *func) const
 Returns string for prepending output (used by error reporting macros).

Additional Inherited Members

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.
Domaindomain
 Link to domain object, useful for communicating with other FEM components.

Detailed Description

Abstract base class for all active boundary conditions. Design of active boundary conditions are subject to change.

Definition at line 63 of file activebc.h.

Constructor & Destructor Documentation

◆ ActiveBoundaryCondition()

◆ ~ActiveBoundaryCondition()

virtual oofem::ActiveBoundaryCondition::~ActiveBoundaryCondition ( )
inlinevirtual

Destructor.

Definition at line 73 of file activebc.h.

Member Function Documentation

◆ addElementSide()

virtual void oofem::ActiveBoundaryCondition::addElementSide ( int elem,
int side )
inlinevirtual

Adds element for active boundary condition.

Parameters
elemElement number.
sideSide number.

Reimplemented in oofem::WeakPeriodicBoundaryCondition.

Definition at line 93 of file activebc.h.

References OOFEM_ERROR.

Referenced by initializeFrom().

◆ assemble()

virtual void oofem::ActiveBoundaryCondition::assemble ( SparseMtrx & answer,
TimeStep * tStep,
CharType type,
const UnknownNumberingScheme & r_s,
const UnknownNumberingScheme & c_s,
double scale = 1.0,
void * lock = nullptr )
inlinevirtual

Assembles B.C. contributions to specified matrix.

Parameters
[in,out]answerMatrix to assemble to.
tStepActive time step.
tStepActive time step.
typeType of matrix to assemble.
r_sRow numbering scheme.
c_sColumn numbering scheme.
scaleScaling factor.
omp_lockoptional OMP lock to ensure correct update of answer

Reimplemented in oofem::ContactBoundaryCondition, oofem::LinearConstraintBC, oofem::MixedGradientPressureNeumann, oofem::MixedGradientPressureWeakPeriodic, oofem::PrescribedDispSlipBCNeumannRC, oofem::PrescribedGradientBCNeumann, oofem::PrescribedGradientBCWeak, oofem::PrescribedMean, oofem::SurfaceTensionBoundaryCondition, oofem::TransportGradientNeumann, oofem::TransverseReinfConstraint, and oofem::WeakPeriodicBoundaryCondition.

Definition at line 107 of file activebc.h.

References oofem::GeneralBoundaryCondition::scale().

Referenced by oofem::EffectiveTangentAssembler::assembleFromActiveBC(), and oofem::TangentAssembler::assembleFromActiveBC().

◆ assembleVector()

virtual void oofem::ActiveBoundaryCondition::assembleVector ( FloatArray & answer,
TimeStep * tStep,
CharType type,
ValueModeType mode,
const UnknownNumberingScheme & s,
FloatArray * eNorms = nullptr,
void * lock = nullptr )
inlinevirtual

Assembles B.C. contributions to specified vector.

Parameters
[in,out]answerVector to assemble to.
tStepActive time step.
typeType of matrix to assemble.
modeMode of value.
sNumbering scheme.
eNormsNorms for each dofid.
omp_lockoptional OMP lock to ensure correct update of answer
Returns
Equivalent of the sum of the element norm (squared) of assembled vector.

Reimplemented in oofem::ContactBoundaryCondition, oofem::LinearConstraintBC, oofem::MixedGradientPressureDirichlet, oofem::MixedGradientPressureNeumann, oofem::MixedGradientPressureWeakPeriodic, oofem::PrescribedDispSlipBCNeumannRC, oofem::PrescribedGradientBCNeumann, oofem::PrescribedGradientBCWeak, oofem::PrescribedMean, oofem::SurfaceTensionBoundaryCondition, oofem::TransportGradientNeumann, oofem::TransverseReinfConstraint, and oofem::WeakPeriodicBoundaryCondition.

Definition at line 121 of file activebc.h.

Referenced by oofem::ExternalForceAssembler::assembleFromActiveBC(), and oofem::InternalForceAssembler::assembleFromActiveBC().

◆ computeDofTransformation()

virtual void oofem::ActiveBoundaryCondition::computeDofTransformation ( ActiveDof * dof,
FloatArray & masterContribs )
inlinevirtual

◆ giveBcValue()

virtual double oofem::ActiveBoundaryCondition::giveBcValue ( Dof * dof,
ValueModeType mode,
TimeStep * tStep )
inlinevirtual

Returns the prescribed value of a dof (if any).

Reimplemented in oofem::MixedGradientPressureDirichlet, oofem::PrescribedGradientBCPeriodic, and oofem::TransportGradientPeriodic.

Definition at line 160 of file activebc.h.

◆ giveLocationArrays()

virtual void oofem::ActiveBoundaryCondition::giveLocationArrays ( std ::vector< IntArray > & rows,
std ::vector< IntArray > & cols,
CharType type,
const UnknownNumberingScheme & r_s,
const UnknownNumberingScheme & c_s )
inlinevirtual

Gives a list of location arrays that will be assembled. This should only be used to construct zero structure in sparse matrices. The rows and columns location arrays returned in tuples (stored in vector), allowing to efficiently assemble and allocate off-diagonal blocks. The nonzero entries are assembled and allocated for entries at (rows[i], cols[i]) positions.

Parameters
rowsList of location arrays for r_s.
colsList of location arrays for c_s.
typeType of matrix to assemble.
r_sRow numbering scheme.
c_sColumn numbering scheme.

Reimplemented in oofem::LinearConstraintBC, oofem::MixedGradientPressureNeumann, oofem::MixedGradientPressureWeakPeriodic, oofem::PrescribedDispSlipBCNeumannRC, oofem::PrescribedGradientBCNeumann, oofem::PrescribedGradientBCWeak, oofem::SurfaceTensionBoundaryCondition, oofem::TransportGradientNeumann, and oofem::TransverseReinfConstraint.

Definition at line 137 of file activebc.h.

Referenced by oofem::CompCol::buildInternalStructure(), oofem::DynCompCol::buildInternalStructure(), oofem::DynCompRow::buildInternalStructure(), oofem::PetscSparseMtrx::buildInternalStructure(), oofem::PetscSparseMtrx::buildInternalStructure(), oofem::Skyline::buildInternalStructure(), oofem::SkylineUnsym::buildInternalStructure(), and oofem::SymCompCol::buildInternalStructure().

◆ giveMasterDof()

virtual Dof * oofem::ActiveBoundaryCondition::giveMasterDof ( ActiveDof * dof,
int mdof )
inlinevirtual

Give the pointer to master dof belonging to active DOF.

Parameters
dofActive dof belonging to receiver.
mdofLocal master dof number.
Returns
Master dof.

Reimplemented in oofem::MixedGradientPressureDirichlet, oofem::PrescribedGradientBCPeriodic, oofem::SolutionbasedShapeFunction, and oofem::TransportGradientPeriodic.

Definition at line 181 of file activebc.h.

References OOFEM_ERROR.

◆ giveNumberOfMasterDofs()

virtual int oofem::ActiveBoundaryCondition::giveNumberOfMasterDofs ( ActiveDof * dof)
inlinevirtual

Allows for active boundary conditions to handle their own special DOF.

Parameters
dofActive dof belonging to receiver.
Returns
Number of primary master DOFs.

Reimplemented in oofem::MixedGradientPressureDirichlet, oofem::PrescribedGradientBCPeriodic, oofem::SolutionbasedShapeFunction, and oofem::TransportGradientPeriodic.

Definition at line 171 of file activebc.h.

References OOFEM_ERROR.

◆ giveUnknown() [1/2]

virtual double oofem::ActiveBoundaryCondition::giveUnknown ( PrimaryField & field,
ValueModeType mode,
TimeStep * tStep,
ActiveDof * dof )
inlinevirtual

Computes the value of the dof.

Parameters
fieldField to take value from.
modeMode of unknown value.
tStepTime step.
dofActive dof for which to obtain the value.
Returns
Value of dof.

Reimplemented in oofem::MixedGradientPressureDirichlet, oofem::PrescribedGradientBCPeriodic, oofem::SolutionbasedShapeFunction, and oofem::TransportGradientPeriodic.

Definition at line 197 of file activebc.h.

References OOFEM_ERROR.

◆ giveUnknown() [2/2]

virtual double oofem::ActiveBoundaryCondition::giveUnknown ( ValueModeType mode,
TimeStep * tStep,
ActiveDof * dof )
inlinevirtual

Computes the value of the dof.

Parameters
modeMode of unknown value.
tStepTime step.
dofActive dof for which to obtain the value.
Returns
Value of dof.

Reimplemented in oofem::MixedGradientPressureDirichlet, oofem::PrescribedGradientBCPeriodic, oofem::SolutionbasedShapeFunction, and oofem::TransportGradientPeriodic.

Definition at line 208 of file activebc.h.

References OOFEM_ERROR.

◆ hasBc()

virtual bool oofem::ActiveBoundaryCondition::hasBc ( Dof * dof,
TimeStep * tStep )
inlinevirtual

Returns the prescribed value of a dof (if any).

Returns
True if dof is prescribed.

Reimplemented in oofem::MixedGradientPressureDirichlet, oofem::PrescribedGradientBCPeriodic, oofem::SolutionbasedShapeFunction, and oofem::TransportGradientPeriodic.

Definition at line 165 of file activebc.h.

◆ initializeFrom()

void oofem::ActiveBoundaryCondition::initializeFrom ( InputRecord & ir)
inlineoverridevirtual

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
irInput record to initialize from.
priorityPriority of the input record. This is used to determine the order of initialization

Reimplemented from oofem::FEMComponent.

Reimplemented in oofem::LinearConstraintBC, oofem::MixedGradientPressureBC, oofem::MixedGradientPressureDirichlet, oofem::MixedGradientPressureNeumann, oofem::MixedGradientPressureWeakPeriodic, oofem::PrescribedDispSlipBCNeumannRC, oofem::PrescribedDispSlipMultiple, oofem::PrescribedGradientBCNeumann, oofem::PrescribedGradientBCPeriodic, oofem::PrescribedGradientBCWeak, oofem::PrescribedGradientBCWeakDirichlet, oofem::PrescribedGradientBCWeakPeriodic, oofem::PrescribedGradientMultiple, oofem::PrescribedMean, oofem::SolutionbasedShapeFunction, oofem::StructuralPenaltyContactBoundaryCondition, oofem::SurfaceTensionBoundaryCondition, oofem::TransportGradientNeumann, oofem::TransportGradientPeriodic, oofem::TransverseReinfConstraint, and oofem::WeakPeriodicBoundaryCondition.

Definition at line 75 of file activebc.h.

References _IFT_ActiveBoundaryCondition_elementSides, addElementSide(), oofem::IntArray::giveSize(), and IR_GIVE_OPTIONAL_FIELD.

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

◆ isPrimaryDof()

virtual bool oofem::ActiveBoundaryCondition::isPrimaryDof ( ActiveDof * dof)
inlinevirtual

Checks to see if the dof is a primary DOF.

Returns
True if ActiveDof is a primary DOF.

Reimplemented in oofem::MixedGradientPressureDirichlet, oofem::PrescribedGradientBCPeriodic, oofem::SolutionbasedShapeFunction, and oofem::TransportGradientPeriodic.

Definition at line 156 of file activebc.h.

◆ requiresActiveDofs()


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

This page is part of the OOFEM-3.0 documentation. Copyright Copyright (C) 1994-2025 Borek Patzak Bořek Patzák
Project e-mail: oofem@fsv.cvut.cz
Generated at for OOFEM by doxygen 1.15.0 written by Dimitri van Heesch, © 1997-2011