Commit c3ed9f21 authored by Sreekanth Arikatla's avatar Sreekanth Arikatla

REFAC: Replace all TODOs with Doxygen todo tag

parent 25f51e12
......@@ -95,7 +95,7 @@ BoneDrillingCH::erodeBone()
if (m_nodalDensity[cd.nodeIdx] <= 0.)
{
// TODO: Unused variable, maybe used in furture?
/// \todo Unused variable, maybe used in furture?
// lock.lock();
// m_erodedNodes.push_back(cd.nodeId);
// lock.unlock();
......
......@@ -89,7 +89,7 @@ private:
std::vector<double> m_nodalDensity; ///> Density of the bone
double m_initialBoneDensity = 1.0; ///> Density of the bone before the start of the drilling process
// std::vector<size_t> m_erodedNodes; // TODO: Unused variable
// std::vector<size_t> m_erodedNodes; /// \todo Unused variable
std::vector<bool> m_nodeRemovalStatus; ///> Keeps track of the removal status of the node
std::vector<std::vector<size_t>> m_nodalCardinalSet; ///> Keeps track of the removal status of the node
......
......@@ -144,6 +144,6 @@ PBDCollisionHandling::generatePBDConstraints()
m_PBDConstraints.push_back(c);
}
//TODO: generating PbdPointTriangleConstraint from the VTColData should be added
//\todo generating PbdPointTriangleConstraint from the VTColData should be added
}
}
......@@ -33,7 +33,7 @@ PbdConstantDensityConstraint::initConstraint(PbdModel& model, const double)
// constraint parameters
// Refer: Miller, et al 2003 "Particle-Based Fluid Simulation for Interactive Applications."
// TODO: Check if these numbers can be variable
/// \todo Check if these numbers can be variable
m_wPoly6Coeff = 315.0 / (64.0 * PI * pow(m_maxDist, 9));
m_wSpikyCoeff = 15.0 / (PI * pow(m_maxDist, 6));
......
......@@ -21,7 +21,7 @@
#pragma once
// TODO: Remove this in TBB 2019 Update 4: https://github.com/intel/tbb/blob/tbb_2019/CHANGES#L117
/// \todo Remove this in TBB 2019 Update 4: https://github.com/intel/tbb/blob/tbb_2019/CHANGES#L117
#define TBB_PREVIEW_GLOBAL_CONTROL 1
#include <tbb/tbb.h>
......
......@@ -31,7 +31,7 @@
namespace imstk
{
// TODO: Move to appropriate place
/// \todo Move to appropriate place
enum class ForceModelType
{
StVK,
......@@ -45,7 +45,7 @@ enum class ForceModelType
none
};
// TODO: Move to appropriate place
/// \todo Move to appropriate place
enum class HyperElasticMaterialType
{
StVK,
......@@ -91,10 +91,10 @@ enum class HyperElasticMaterialType
/// numberOfThreads Number of threads spawned by the force model
/// [default = 0]
///
/// TODO: Convert this to input through JSON format
/// \todo Convert this to input through JSON format
class ForceModelConfig
{
// TODO: Do this in a better way
/// \todo Do this in a better way
struct customOptionsList
{
char femMethod[256];
......
......@@ -250,7 +250,7 @@ FEMDeformableBodyModel::initializeMassMatrix(const bool saveToDisk /*= false*/)
this->initializeEigenMatrixFromVegaMatrix(*vegaMatrix, m_M);
// TODO: Add option to save mass matrix to file
/// \todo Add option to save mass matrix to file
return true;
}
......
......@@ -393,7 +393,7 @@ PbdModel::initializeConstantDensityConstraint(const double stiffness)
&& m_mesh->getType() != Geometry::Type::HexahedralMesh
&& m_mesh->getType() != Geometry::Type::PointSet)
{
LOG(WARNING) << "Constant constraint should come with a mesh"; //TODO: Really only need a point cloud, so may need to change this.
LOG(WARNING) << "Constant constraint should come with a mesh"; //\todo Really only need a point cloud, so may need to change this.
return false;
}
......
......@@ -40,7 +40,7 @@ vtkStandardNewMacro(vtkCapsuleSource);
//----------------------------------------------------------------------------
// Construct sphere with radius=0.5 and default resolution 8 in both Phi
// and Theta directions. Theta ranges from (0,360) and phi (0,180) degrees.
// \todo
/// \todo
vtkCapsuleSource::vtkCapsuleSource(int res)
{
res = res < 8 ? 8 : res;
......
......@@ -61,7 +61,7 @@ CollisionGraph::addInteractionPair(CollidingObjectPtr A,
return intPair;
}
//TODO: Refactor -> PBD only
//\todo Refactor -> PBD only
void
CollisionGraph::addInteractionPair(std::shared_ptr<PbdInteractionPair> pair)
{
......
......@@ -66,7 +66,7 @@ public:
CollisionHandling::Type CHAType,
CollisionHandling::Type CHBType);
//TODO: Refactor -> PBD only
//\todo Refactor -> PBD only
InteractionPairPtr addInteractionPair(CollidingObjectPtr A,
CollidingObjectPtr B,
CollisionDetectionPtr CD,
......@@ -99,7 +99,7 @@ public:
const std::unordered_map<CollidingObjectPtr, std::vector<InteractionPairPtr>>& getInteractionPairMap() const;
protected:
std::vector<std::shared_ptr<PbdInteractionPair>> m_interactionPbdPairList; //TODO: Refactor -> PBD only
std::vector<std::shared_ptr<PbdInteractionPair>> m_interactionPbdPairList; //\todo Refactor -> PBD only
std::vector<InteractionPairPtr> m_interactionPairList; ///< All interaction pairs in the collision graph
std::unordered_map<CollidingObjectPtr, std::vector<InteractionPairPtr>> m_interactionPairMap; ///< Map of interaction pairs per colliding object
......
......@@ -28,7 +28,7 @@
namespace imstk
{
// TODO: Complete this
/// \todo Complete this
class RigidBodyState
{
public:
......
......@@ -115,7 +115,7 @@ OpenVRCommand::Execute(
// grip button
if (eventId == vtkCommand::MiddleButtonPressEvent)
{
// TODO: Take a screenshot
/// \todo Take a screenshot
this->AbortFlagOn();
}
......
......@@ -86,7 +86,7 @@ DirectLinearSolver<Matrixd>::solve(Vectord& x)
{
if (!m_linearSystem)
{
// TODO: Log this
/// \todo Log this
return;
}
......
......@@ -145,7 +145,7 @@ NewtonSolver::updateJacobian(const Vectord& x)
auto& b = m_nonLinearSystem->m_F(x, m_isSemiImplicit);
auto linearSystem = std::make_shared<LinearSolverType::LinearSystemType>(A, b);
//linearSystem->setLinearProjectors(m_nonLinearSystem->getLinearProjectors()); // TODO: Left for near future reference. Clear in future.
//linearSystem->setLinearProjectors(m_nonLinearSystem->getLinearProjectors()); /// \todo Left for near future reference. Clear in future.
m_linearSolver->setSystem(linearSystem);
return b.dot(b);
......@@ -160,7 +160,7 @@ NewtonSolver::updateForcingTerm(const double ratio, const double stopTolerance,
// Save guard to prevent the forcing term to become too small for far away iterates
if (m_gamma * forcingTermSqr > 0.1)
{
// TODO: Log this
/// \todo Log this
eta = std::max(eta, m_gamma * forcingTermSqr);
}
......
......@@ -46,7 +46,7 @@ NonLinearSolver::armijo(const Vectord& dx, Vectord& x, const double previousFnor
/// Initialize temporaries
if (!m_nonLinearSystem)
{
// TODO: log this
/// \todo log this
return previousFnorm;
}
......@@ -55,7 +55,7 @@ NonLinearSolver::armijo(const Vectord& dx, Vectord& x, const double previousFnor
// Exit if the function norm satisfies the Armijo-Goldstein condition
if (currentFnorm < (1.0 - m_alpha * lambda[0]) * previousFnorm)
{
// TODO: Log this
/// \todo Log this
return currentFnorm;
}
......@@ -76,7 +76,7 @@ NonLinearSolver::armijo(const Vectord& dx, Vectord& x, const double previousFnor
// Exit if the function norm satisfies the Armijo-Goldstein condition
if (currentFnorm < (1.0 - m_alpha * lambda[0]) * previousFnorm)
{
// TODO: Log this
/// \todo Log this
return currentFnorm;
}
......@@ -90,7 +90,7 @@ NonLinearSolver::armijo(const Vectord& dx, Vectord& x, const double previousFnor
if (i == m_armijoMax)
{
// TODO: Add to logger
/// \todo Add to logger
// std::cout << "Maximum number of Armijo iterations reached." << std::endl;
}
return currentFnorm;
......
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