File kernel/src/modelingTools/BoundaryCondition.hpp#
Go to the source code of this file
Typedefs
-
typedef void (*FPtrPrescribedVelocity)(double, unsigned int, double*)#
-
class BoundaryCondition
- #include <BoundaryCondition.hpp>
This class models simple boundary conditions for prescribing the velocities in a Dynamical System.
A simple boundary condition is considered to fix a component \( j \) of the velocity vector, i.e., \( v_j(t) = bc(t) \) where \( bc(t) \) is a given function of time.
Subclassed by FixedBC, HarmonicBC
Public Functions
-
BoundaryCondition(SP::UnsignedIntVector newVelocityIndices)
Basic constructor.
- Parameters:
newVelocityIndices – the indices of the velocity subjected to prescribed velocities
-
BoundaryCondition(SP::UnsignedIntVector newVelocityIndices, SP::SiconosVector newVelocityValues)
Constructor with constant prescribed values.
- Parameters:
newVelocityIndices – the indices of the velocity subjected to prescribed velocities
newVelocityValues – the values of the prescribed velocities
-
virtual ~BoundaryCondition()
destructor
-
inline SP::UnsignedIntVector velocityIndices()
to get the velocityIndices
- Returns:
a pointer on _velocityIndices
-
inline SP::SiconosVector prescribedVelocity()
to get the prescribedVelocity
- Returns:
a pointer on _prescribedVelocity
-
inline SP::SiconosVector prescribedVelocityOld()
to get the prescribedVelocityOld
- Returns:
a pointer on _prescribedVelocityOld
-
inline void setComputePrescribedVelocityFunction(const std::string &pluginPath, const std::string &functionName)
allow to set a specified function to compute prescribedVelocity
- Parameters:
pluginPath – the complete path to the plugin
functionName – the name of the function to use in this plugin
-
virtual void computePrescribedVelocity(double time)
default function to compute the precribed velocities
- Parameters:
time – : the current time
-
void display()
display
Protected Functions
-
ACCEPT_SERIALIZATION(BoundaryCondition)#
-
inline BoundaryCondition()#
protected default constructor
-
BoundaryCondition(SP::UnsignedIntVector newVelocityIndices)