Class BoundaryCondition

Defined in Program listing for file kernel/src/modelingTools/BoundaryCondition.hpp

class BoundaryCondition

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)

brief 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

virtual void computePrescribedVelocity(double time)

default function to compute the precribed velocities

Parameters
  • time: : the current time

SP::SiconosVector prescribedVelocity()

to get the prescribedVelocity

Return
a pointer on _prescribedVelocity

SP::SiconosVector prescribedVelocityOld()

to get the prescribedVelocityOld

Return
a pointer on _prescribedVelocityOld

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

SP::UnsignedIntVector velocityIndices()

to get the velocityIndices

Return
a pointer on _velocityIndices