Commit 92096c15 authored by Quentin Khan's avatar Quentin Khan

Doc of FCoreCommon.hpp

parent ae904e8e
...@@ -45,12 +45,10 @@ enum FFmmOperations { ...@@ -45,12 +45,10 @@ enum FFmmOperations {
*/ */
class FAbstractAlgorithm { class FAbstractAlgorithm {
protected: protected:
//< Where to start the work
int upperWorkingLevel; int upperWorkingLevel; ///< Where to start the work
//< Where to end the work (exclusive) int lowerWorkingLevel; ///< Where to end the work (exclusive)
int lowerWorkingLevel; int nbLevelsInTree; ///< Height of the tree
//< Height of the tree
int nbLevelsInTree;
void setNbLevelsInTree(const int inNbLevelsInTree){ void setNbLevelsInTree(const int inNbLevelsInTree){
nbLevelsInTree = inNbLevelsInTree; nbLevelsInTree = inNbLevelsInTree;
...@@ -72,7 +70,7 @@ public: ...@@ -72,7 +70,7 @@ public:
virtual ~FAbstractAlgorithm(){ virtual ~FAbstractAlgorithm(){
} }
/** Execute the whole fmm for given levels. */ /** \brief Execute the whole fmm for given levels. */
virtual void execute(const int inUpperWorkingLevel, const int inLowerWorkingLevel) final { virtual void execute(const int inUpperWorkingLevel, const int inLowerWorkingLevel) final {
upperWorkingLevel = inUpperWorkingLevel; upperWorkingLevel = inUpperWorkingLevel;
lowerWorkingLevel = inLowerWorkingLevel; lowerWorkingLevel = inLowerWorkingLevel;
...@@ -80,7 +78,7 @@ public: ...@@ -80,7 +78,7 @@ public:
executeCore(FFmmNearAndFarFields); executeCore(FFmmNearAndFarFields);
} }
/** Execute the whole fmm. */ /** \brief Execute the whole fmm. */
virtual void execute() final { virtual void execute() final {
upperWorkingLevel = 2; upperWorkingLevel = 2;
lowerWorkingLevel = nbLevelsInTree; lowerWorkingLevel = nbLevelsInTree;
...@@ -88,7 +86,7 @@ public: ...@@ -88,7 +86,7 @@ public:
executeCore(FFmmNearAndFarFields); executeCore(FFmmNearAndFarFields);
} }
/** Execute only some FMM operations for given levels. */ /** \brief Execute only some FMM operations for given levels. */
virtual void execute(const unsigned operationsToProceed, const int inUpperWorkingLevel, const int inLowerWorkingLevel) final { virtual void execute(const unsigned operationsToProceed, const int inUpperWorkingLevel, const int inLowerWorkingLevel) final {
upperWorkingLevel = inUpperWorkingLevel; upperWorkingLevel = inUpperWorkingLevel;
lowerWorkingLevel = inLowerWorkingLevel; lowerWorkingLevel = inLowerWorkingLevel;
...@@ -96,7 +94,7 @@ public: ...@@ -96,7 +94,7 @@ public:
executeCore(operationsToProceed); executeCore(operationsToProceed);
} }
/** Execute only some steps. */ /** \brief Execute only some steps. */
virtual void execute(const unsigned operationsToProceed) final { virtual void execute(const unsigned operationsToProceed) final {
upperWorkingLevel = 2; upperWorkingLevel = 2;
lowerWorkingLevel = nbLevelsInTree; lowerWorkingLevel = nbLevelsInTree;
......
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