siconos.kernel.BoundaryCondition (Python class)

class siconos.kernel.BoundaryCondition(*args)[source]

Bases: object

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.

Generated class (swig), based on C++ header Program listing for file kernel/src/modelingTools/BoundaryCondition.hpp.


BoundaryCondition(UnsignedIntVector newVelocityIndices)

Basic constructor.

Parameters:newVelocityIndices – the indices of the velocity subjected to prescribed velocities
BoundaryCondition(UnsignedIntVector newVelocityIndices, array_like (np.float64, 1D) newVelocityValues)

brief Constructor with constant prescribed values

  • newVelocityIndices – the indices of the velocity subjected to prescribed velocities
  • newVelocityValues – the values of the prescribed velocities
computePrescribedVelocity(double time) → None[source]

default function to compute the precribed velocities

Parameters:time – : the current time
prescribedVelocity() -> array_like (np.float64, 1D)[source]

to get the prescribedVelocity

Returns:a pointer on _prescribedVelocity
prescribedVelocityOld() -> array_like (np.float64, 1D)[source]

to get the prescribedVelocityOld

Returns:a pointer on _prescribedVelocityOld
setComputePrescribedVelocityFunction(str pluginPath, str functionName) → None[source]

allow to set a specified function to compute prescribedVelocity

  • pluginPath – the complete path to the plugin
  • functionName – the name of the function to use in this plugin
velocityIndices() → UnsignedIntVector[source]

to get the velocityIndices

Returns:a pointer on _velocityIndices