Commit 8a34c9f3 authored by BRAMAS Berenger's avatar BRAMAS Berenger
parents 791a25f6 0516486e
......@@ -468,7 +468,7 @@ SORT_MEMBER_DOCS = YES
# by member name. If set to NO (the default) the members will appear in
# declaration order.
SORT_BRIEF_DOCS = NO
SORT_BRIEF_DOCS = YES
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
# will sort the (brief and detailed) documentation of class members so that
......@@ -985,7 +985,7 @@ HTML_ALIGN_MEMBERS = YES
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
HTML_DYNAMIC_SECTIONS = NO
HTML_DYNAMIC_SECTIONS = YES
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
......@@ -1740,7 +1740,7 @@ DIRECTORY_GRAPH = YES
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
# visible in IE 9+ (other browsers do not have this requirement).
DOT_IMAGE_FORMAT = png
DOT_IMAGE_FORMAT = svg
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
......@@ -1749,7 +1749,7 @@ DOT_IMAGE_FORMAT = png
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
# visible. Older versions of IE do not have SVG support.
INTERACTIVE_SVG = NO
INTERACTIVE_SVG = YES
# The tag DOT_PATH can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
......
......@@ -28,21 +28,21 @@
/**
* @author Berenger Bramas (berenger.bramas@inria.fr)
* @class FBasicParticle
* Please read the license
*
* This class defines a container which can holds one type (AttributeClass)
* for each particle.
* The memory is allocated for all informations, the positions and the
* request type.
* For example is one want to store a struct for each particle:
* @code
* @code struct AStruct{
* @code ...
* @code };
* @code FBasicParticleContainer<1, AStruct> container;
* And then the access is done using:
* @code AStruct* strucs = container.getAttributes<0>();
* For example if one wants to store a struct for each particle:
* \code
* struct AStruct{ ... };
* FBasicParticleContainer<1, AStruct> container;
* \endcode
* And then access is done using:
* \code
* AStruct* strucs = container.getAttributes<0>();
* \endcode
*/
template <unsigned NbAttributesPerParticle, class AttributeClass = FReal >
class FBasicParticleContainer : public FAbstractParticleContainer, public FAbstractSerializable {
......
......@@ -20,7 +20,6 @@
/**
* @author Berenger Bramas (berenger.bramas@inria.fr)
* @class FFmaParticle
* Please read the license
*
* This class defines a particle container for FMA loader.
......
......@@ -638,23 +638,35 @@ public:
return this->current.tree->cellsAt(this->currentLocalLevel)[this->currentLocalIndex];
}
/** Get the child of the current cell
* This function return an array of CellClass (array size = 8)
* User has to test each case to know if there is a cell
* @return the child array
/** Gets the children of the current cell.
*
* This function return an array of 8 CellClass. To konw whether
* a child cell exists or not, the pointer must be checked.
*
* @return the 8-child array.
*/
CellClass** getCurrentChild() const {
// are we at the bottom of the suboctree
if(this->current.tree->getSubOctreeHeight() - 1 == this->currentLocalLevel ){
// then return first level of the suboctree under
return &this->current.middleTree->leafs(this->currentLocalIndex)->cellsAt(0)[0];
}
else{
} else {
// else simply return the array at the right position
return &this->current.tree->cellsAt(this->currentLocalLevel + 1)[this->currentLocalIndex << 3];
}
}
/** Gets the children of the current cell.
*
* This function return an array of 8 CellClass. To konw whether
* a child cell exists or not, the pointer must be checked.
*
* @return the 8-child array.
*/
CellClass** getCurrentChildren() const {
return getCurrentChild();
}
/** Get the part of array that contains all the pointers
*
*/
......
This diff is collapsed.
......@@ -20,7 +20,9 @@
/**
* @author Berenger Bramas (berenger.bramas@inria.fr)
* @class This class is a basic implementation of Complexe.
* @class FComplex.hpp
*
* This class is a basic implementation of Complexe.
* Please read the license
*
* Propose basic complexe class.
......
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