Commit ef946fcf authored by Christoph Rettinger's avatar Christoph Rettinger
Browse files

Merge branch 'documentation' into 'master'

Documentation maintenance

See merge request !479
parents 3b00f584 25af88f4
Pipeline #34263 failed with stages
in 26 minutes and 29 seconds
......@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
//
//! \file Polyhedron.h
//! \file ConvexPolyhedron.h
//! \author Christian Godenschwager <christian.godenschwager@fau.de>
//! \brief Marshalling of objects for data transmission or storage.
//
......@@ -55,7 +55,6 @@ void marshal( mpi::SendBuffer& buffer, const ConvexPolyhedron& obj );
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Passed on to rigid body unmarshalling.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, ConvexPolyhedronParameters& objparam );
......
......@@ -54,9 +54,7 @@ namespace pe {
* \param sid Unique system-specific ID for the ConvexPolyhedron.
* \param uid User-specific ID for the ConvexPolyhedron.
* \param gpos Global geometric center of the ConvexPolyhedron.
* \param rpos The relative position within the body frame of a superordinate body.
* \param q The orientation of the ConvexPolyhedron's body frame in the global world frame.
* \param radius The radius of the ConvexPolyhedron \f$ (0..\infty) \f$.
* \param material The material of the ConvexPolyhedron.
* \param global specifies if the ConvexPolyhedron should be created in the global storage
* \param communicating specifies if the ConvexPolyhedron should take part in synchronization (syncNextNeighbour, syncShadowOwner)
......
......@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
//
//! \file PrepareDistanceComputations.h
//! \file DistanceComputations.h
//! \ingroup mesh
//! \author Christian Godenschwager <christian.godenschwager@fau.de>
//
......
......@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
//
//! \file VCycles.h.impl
//! \file VCycles.impl.h
//! \ingroup pde
//! \author Dominik Bartuschat <dominik.bartuschat@fau.de>
//! \author Michael Kuron <mkuron@icp.uni-stuttgart.de>
......
......@@ -144,7 +144,7 @@ using Materials = std::vector<Material>; //!< Vector for materials.
/*!\brief Unique material ID.
*
* Every registered material has a unique MaterialID that can be used wherever the material is
* required. The \b pe engine provides a couple of predefined materials (see the \ref materials
* required. The \b pe engine provides a couple of predefined materials (see the \ref Materials
* module). However, it is possible to define a custom material via the createMaterial() function:
\code
......
......@@ -326,7 +326,7 @@ size_t HashGrids::HashGrid::hash( BodyID body ) const
*
* \param x X value of the point.
* \param y Y value of the point.
* \param y Z value of the point.
* \param z Z value of the point.
* \return The hash value (=cell association) of the point.
*
* The hash calculation uses modulo operations in order to spatially map entire blocks of connected
......@@ -569,12 +569,12 @@ void HashGrids::HashGrid::enlarge()
//=================================================================================================
//*************************************************************************************************
/*!\brief Constructor for the HashGrids class.
*
* \param bodystorage Reference to the general body storage.
*
* Note that all (local, global and remote) must be contained in the body storage.
*/
//\brief Constructor for the HashGrids class.
//*
//* \param bodystorage Reference to the general body storage.
//*
//* Note that all (local, global and remote) must be contained in the body storage.
//
//HashGrids::HashGrids( BodyStorage& bodystorage )
// : bodystorage_( bodystorage )
// , bodystorageShadowCopies_( bodystorage )
......
......@@ -502,7 +502,6 @@ void HashGrids::HashGrid::processBodies( BodyID* bodies, size_t bodyCount, Conta
/*!\brief Computes closest ray-body intersection of cell with center at point x,y,z and neighboring ones.
*
* \param blockCell index of cell within block grid.
* \param blockAABB AABB of the block this grid corresponds to.
* \param ray Ray being casted trough grid.
* \param t_closest Distance of closest object from ray origin. Will be updated if closer body found.
* \param n_closest Normal of intersection point.
......@@ -604,8 +603,8 @@ BodyID HashGrids::HashGrid::getBodyIntersectionForBlockCell(const Vector3<int32_
*
* \param ray Ray getting shot through this grid.
* \param blockAABB AABB of the block this grid corresponds to.
* \param t Reference for the distance.
* \param n Reference for the intersection normal.
* \param t_closest Reference for the distance.
* \param n_closest Reference for the intersection normal.
* \return BodyID of closest body, NULL if none found.
*
* This function calculates ray-cell intersections and the closest body in those cells. Also, neighboring
......
......@@ -402,7 +402,7 @@ inline const Vec3& EPA::EPA_Triangle::getNormal() const
*/
inline Vec3 EPA::EPA_Triangle::getClosestPoint(const std::vector<Vec3>& points) const
{
return bar_[0] * points[indices_[0]]
return bar_[0] * points[indices_[0]]
+ bar_[1] * points[indices_[1]]
+ bar_[2] * points[indices_[2]];
......@@ -469,8 +469,9 @@ inline bool EPA::EPA_TriangleComp::operator()( const EPA_Triangle *tria1,
//*************************************************************************************************
/*! \brief Calculates a support point of a body extended by threshold.
* Adds this support and the base points at bodies a and b to the vector.
* \param geom The body.
* Adds this support and the base points at bodies A and B to the vector.
* \param geom1 The body A.
* \param geom2 The body B.
* \param dir The support point direction.
* \param margin Extension of the Body.
*/
......@@ -496,8 +497,9 @@ inline void EPA::pushSupportMargin(const GeomPrimitive &geom1, const GeomPrimiti
//*************************************************************************************************
/*! \brief Calculates a support point of a body extended by threshold.
* Replaces the old value in the vectors at "IndexToReplace" with this support and the base points at bodies a and b .
* \param geom The body.
* Replaces the old value in the vectors at "IndexToReplace" with this support and the base points at bodies A and B.
* \param geom1 The body A.
* \param geom2 The body B.
* \param dir The support point direction.
* \param margin Extension of the Body.
*/
......
......@@ -185,10 +185,11 @@ inline bool GJK::zeroLengthVector(const Vec3& vec) const
//*************************************************************************************************
/*!\brief Calculate a support point of a body extended by threshold.
* \param geom The body.
/*!\brief Calculate a support point of a body extended by a threshold.
* \param geom1 The body A.
* \param geom2 The body B.
* \param dir The support point direction.
* \param threshold Extension of the Body.
* \param margin Extension of the Body.
*/
inline const Vec3 GJK::putSupport(const GeomPrimitive &geom1, const GeomPrimitive &geom2, const Vec3& dir, const real_t margin,
std::vector<Vec3> &simplex, std::vector<Vec3> &supportA, std::vector<Vec3> &supportB, size_t index){
......
......@@ -61,7 +61,7 @@ public:
/*!\brief Marshalling rigid body parameters dynamically.
*
* \param buffer The buffer to be filled.
* \param obj The object to be marshalled dynamically.
* \param b The object to be marshalled dynamically.
* \return void
*
* The rigid body is casted dynamically to its original type and then marshalled. For recognition
......@@ -97,7 +97,6 @@ public:
/*!\brief Marshalling rigid body parameters dynamically.
*
* \param buffer The buffer to be filled.
* \param obj The object to be marshalled dynamically.
* \return void
*
* The rigid body is casted dynamically to its original type and then marshalled. For recognition
......
......@@ -27,36 +27,17 @@ namespace pe {
namespace communication {
//*************************************************************************************************
/*!\brief Marshalling rigid body parameters.
*
* \param buffer The buffer to be filled.
* \param obj The object to be marshalled.
* \return void
*/
void marshal( mpi::SendBuffer& buffer, const MPIRigidBodyTrait& obj ) {
buffer << obj.getOwner();
}
//*************************************************************************************************
//*************************************************************************************************
/*!\brief Unmarshalling rigid body parameters.
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Subordinate bodies in unions do not encode velocities but encode relative positions.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, MPIRigidBodyTraitParameter& objparam ) {
buffer >> objparam.owner_;
}
//*************************************************************************************************
/*!\brief Marshalling rigid body parameters.
*
* \param buffer The buffer to be filled.
* \param obj The object to be marshalled.
* \return void
*/
void marshal( mpi::SendBuffer& buffer, const RigidBody& obj ) {
marshal( buffer, obj.MPITrait );
......@@ -76,13 +57,6 @@ void marshal( mpi::SendBuffer& buffer, const RigidBody& obj ) {
//*************************************************************************************************
//*************************************************************************************************
/*!\brief Unmarshalling rigid body parameters.
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Subordinate bodies in unions do not encode velocities but encode relative positions.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, RigidBodyParameters& objparam ) {
unmarshal( buffer, objparam.mpiTrait_ );
......@@ -109,12 +83,6 @@ void unmarshal( mpi::RecvBuffer& buffer, RigidBodyParameters& objparam ) {
//*************************************************************************************************
//*************************************************************************************************
/*!\brief Marshalling parameters of a geometric primitive.
*
* \param buffer The buffer to be filled.
* \param obj The object to be marshalled.
* \return void
*/
void marshal( mpi::SendBuffer& buffer, const GeomPrimitive& obj ) {
marshal( buffer, static_cast<const RigidBody&>( obj ) );
buffer << obj.getMaterial();
......@@ -123,13 +91,6 @@ void marshal( mpi::SendBuffer& buffer, const GeomPrimitive& obj ) {
//*************************************************************************************************
/*!\brief Unmarshalling parameters of a geometric primitive.
*
* \param buffer The buffer to be filled.
* \param obj The object to be marshalled.
* \param hasSuperBody False if body is not part of a union. Passed on to rigid body unmarshalling.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, GeomPrimitiveParameters& objparam ) {
unmarshal( buffer, static_cast<RigidBodyParameters&>( objparam ) );
buffer >> objparam.material_;
......
......@@ -59,7 +59,6 @@ void marshal( mpi::SendBuffer& buffer, const MPIRigidBodyTrait& obj );
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Subordinate bodies in unions do not encode velocities but encode relative positions.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, MPIRigidBodyTraitParameter& objparam );
......@@ -95,7 +94,6 @@ void marshal( mpi::SendBuffer& buffer, const RigidBody& obj );
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Subordinate bodies in unions do not encode velocities but encode relative positions.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, RigidBodyParameters& objparam );
......@@ -126,8 +124,7 @@ void marshal( mpi::SendBuffer& buffer, const GeomPrimitive& obj );
/*!\brief Unmarshalling parameters of a geometric primitive.
*
* \param buffer The buffer to be filled.
* \param obj The object to be marshalled.
* \param hasSuperBody False if body is not part of a union. Passed on to rigid body unmarshalling.
* \param objparam The object to be marshalled.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, GeomPrimitiveParameters& objparam );
......
......@@ -27,12 +27,6 @@ namespace pe {
namespace communication {
//*************************************************************************************************
/*!\brief Marshalling a sphere primitive.
*
* \param buffer The buffer to be filled.
* \param obj The object to be marshalled.
* \return void
*/
void marshal( mpi::SendBuffer& buffer, const Box& obj ) {
marshal( buffer, static_cast<const GeomPrimitive&>( obj ) );
buffer << obj.getLengths();
......@@ -41,13 +35,6 @@ void marshal( mpi::SendBuffer& buffer, const Box& obj ) {
//*************************************************************************************************
/*!\brief Unmarshalling a sphere primitive.
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Passed on to rigid body unmarshalling.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, BoxParameters& objparam ) {
unmarshal( buffer, static_cast<GeomPrimitiveParameters&>( objparam ) );
buffer >> objparam.lengths_;
......
......@@ -54,7 +54,6 @@ void marshal( mpi::SendBuffer& buffer, const Box& obj );
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Passed on to rigid body unmarshalling.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, BoxParameters& objparam );
......
......@@ -27,12 +27,6 @@ namespace pe {
namespace communication {
//*************************************************************************************************
/*!\brief Marshalling a capsule primitive.
*
* \param buffer The buffer to be filled.
* \param obj The object to be marshalled.
* \return void
*/
void marshal( mpi::SendBuffer& buffer, const Capsule& obj )
{
marshal( buffer, static_cast<const GeomPrimitive&>( obj ) );
......@@ -43,13 +37,6 @@ void marshal( mpi::SendBuffer& buffer, const Capsule& obj )
//*************************************************************************************************
/*!\brief Unmarshalling a capsule primitive.
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Passed on to rigid body unmarshalling.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, CapsuleParameters& objparam )
{
unmarshal( buffer, static_cast<GeomPrimitiveParameters&>( objparam ) );
......
......@@ -54,7 +54,6 @@ void marshal( mpi::SendBuffer& buffer, const Capsule& obj );
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Passed on to rigid body unmarshalling.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, CapsuleParameters& objparam );
......
......@@ -27,12 +27,6 @@ namespace pe {
namespace communication {
//*************************************************************************************************
/*!\brief Marshalling a Ellipsoid primitive.
*
* \param buffer The buffer to be filled.
* \param obj The object to be marshalled.
* \return void
*/
void marshal( mpi::SendBuffer& buffer, const Ellipsoid& obj ) {
marshal( buffer, static_cast<const GeomPrimitive&>( obj ) );
buffer << obj.getSemiAxes();
......@@ -41,13 +35,6 @@ void marshal( mpi::SendBuffer& buffer, const Ellipsoid& obj ) {
//*************************************************************************************************
/*!\brief Unmarshalling a Ellipsoid primitive.
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Passed on to rigid body unmarshalling.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, EllipsoidParameters& objparam ) {
unmarshal( buffer, static_cast<GeomPrimitiveParameters&>( objparam ) );
buffer >> objparam.semiAxes_;
......
......@@ -54,7 +54,6 @@ void marshal( mpi::SendBuffer& buffer, const Ellipsoid& obj );
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Passed on to rigid body unmarshalling.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, EllipsoidParameters& objparam );
......
......@@ -27,12 +27,6 @@ namespace pe {
namespace communication {
//*************************************************************************************************
/*!\brief Marshalling a sphere primitive.
*
* \param buffer The buffer to be filled.
* \param obj The object to be marshalled.
* \return void
*/
void marshal( mpi::SendBuffer& buffer, const Sphere& obj ) {
marshal( buffer, static_cast<const GeomPrimitive&>( obj ) );
buffer << obj.getRadius();
......@@ -41,13 +35,6 @@ void marshal( mpi::SendBuffer& buffer, const Sphere& obj ) {
//*************************************************************************************************
/*!\brief Unmarshalling a sphere primitive.
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Passed on to rigid body unmarshalling.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, SphereParameters& objparam ) {
unmarshal( buffer, static_cast<GeomPrimitiveParameters&>( objparam ) );
buffer >> objparam.radius_;
......
......@@ -54,7 +54,6 @@ void marshal( mpi::SendBuffer& buffer, const Sphere& obj );
*
* \param buffer The buffer from where to read.
* \param objparam The object to be reconstructed.
* \param hasSuperBody False if body is not part of a union. Passed on to rigid body unmarshalling.
* \return void
*/
void unmarshal( mpi::RecvBuffer& buffer, SphereParameters& objparam );
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment