Skip to content

Commit

Permalink
doc: Boundary class documentation improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
fabricix committed Nov 4, 2024
1 parent 84c0fe5 commit 31783ff
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions inc/Boundary.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ using std::vector;
/// \class Boundary
/// \brief Mesh boundary nodes
///
/// This class represents the mesh boundaries for setting up the boundary conditions of the numerical problem in terms of displacement, velocity and acceleration. In a mechanical numerical model the Lagrangian boundary conditions, like external loads, are setting up into the particles representing the physical domain boundary, and during the nodal integration the mesh boundaries conditions should be setting up on the mesh boundaries, in particular this class is created to apply this nodal BCs.
///
/// For a regular mesh are defined two planes in each direction: X0-Xn, Y0-Yn, Z0-Zn. In which the subscript 0 represents the minor coordinate in the direction and n the mayor coordinate of the plane in that direction.
///
/// There are several types of BCs. In fixed boundary condition the node is fixed in all direction during the simulation. In sliding boundary condition the node only is permited to move only in perpendicular direction of the corresponding plane. In free boundary condition the node is free to move in all directions. In earthquake boundary condition allow setting nodal acceleration and velocities in time for introduce a seismic record in the model.
///
/// ### Definition of the planes for setting boundary conditions
///
/// ```
Expand All @@ -36,8 +42,7 @@ using std::vector;
/// Plane Xn : Plane which normal points to the positive direction of axis X
///
/// ```
/// **Note**: If any boundary condition is defined in the input file, sliding boundary condition
/// is chosen, by default, for all planes.
/// **Note**: If any boundary condition is defined in the input file, sliding boundary condition is chosen, by default, for all planes.
///
class Boundary {

Expand Down

0 comments on commit 31783ff

Please sign in to comment.