diff --git a/FunctionSpace/BasisGenerator.h b/FunctionSpace/BasisGenerator.h index 6d3351c31928abdddd503ac57c2cc54fcfe64373..3858bf284f30bdfc7bdcacced0b912b4820f2fed 100644 --- a/FunctionSpace/BasisGenerator.h +++ b/FunctionSpace/BasisGenerator.h @@ -60,7 +60,7 @@ class BasisGenerator{ Deletes this BasisGenerator ** - @fn BasisGenerator::generate + @fn BasisGenerator::generate(int, int, int, std::string) @param elementType The type of the element, on which the requested Basis will be created @param basisType The Basis type @@ -93,7 +93,7 @@ class BasisGenerator{ @li @c lagrange for Lagrange's Basis Functions ** - @fn BasisGenerator::generate + @fn BasisGenerator::generate(int, int, int) @param elementType The type of the element, on which the requested Basis will be created @param basisType The Basis type diff --git a/FunctionSpace/EvaluatedBasis.h b/FunctionSpace/EvaluatedBasis.h index 0ef09504102d050344ef6df0c811cab49db1fbc8..6967d2106560a0517d736ec0132ea39b25a7be5b 100644 --- a/FunctionSpace/EvaluatedBasis.h +++ b/FunctionSpace/EvaluatedBasis.h @@ -1,6 +1,16 @@ #ifndef _EVALUATEDBASIS_H_ #define _EVALUATEDBASIS_H_ +/** + @interface EvaluatedBasis + @brief Common Interface for Evaluated Basis + + This class is the @em common @em interface for all EvaluatedBasis.@n + + An EvaluatedBasis is a @em Basis that has been @em Evaluated at + some points.@n + */ + class EvaluatedBasis{ protected: bool scalar; diff --git a/FunctionSpace/EvaluatedBasisScalar.h b/FunctionSpace/EvaluatedBasisScalar.h index 4ecdeb0f4feece35c6c99d4c96afa258040f84eb..c3a5aff88a2975221673475609c8b442a6faf208 100644 --- a/FunctionSpace/EvaluatedBasisScalar.h +++ b/FunctionSpace/EvaluatedBasisScalar.h @@ -6,6 +6,13 @@ #include "BasisScalar.h" #include "EvaluatedBasis.h" +/** + @class EvaluatedBasisScalar + @brief A @em Scalar EvaluatedBasis + + This class is a @em Scalar EvaluatedBasis.@n +*/ + class EvaluatedBasisScalar: public EvaluatedBasis{ protected: std::vector <std::vector<double>*>* node; diff --git a/FunctionSpace/EvaluatedBasisVector.h b/FunctionSpace/EvaluatedBasisVector.h index b9b686df74b6a6a8d8fc40965b5daa394e5c256c..c5e8c0afaaa53cb2804b95c1321ce8d3ff37e3d8 100644 --- a/FunctionSpace/EvaluatedBasisVector.h +++ b/FunctionSpace/EvaluatedBasisVector.h @@ -6,6 +6,13 @@ #include "BasisVector.h" #include "EvaluatedBasis.h" +/** + @class EvaluatedBasisVector + @brief A @em Vectorial EvaluatedBasis + + This class is a @em Vectorial EvaluatedBasis.@n +*/ + class EvaluatedBasisVector: public EvaluatedBasis{ protected: std::vector <std::vector<fullVector<double> >*>* node; diff --git a/FunctionSpace/FunctionSpaceScalar.h b/FunctionSpace/FunctionSpaceScalar.h index de7c3ababfbaa78dbacafaefcdee6afcd9028a7f..f20368aa46125ba65c9477ff0f0352992c00c178 100644 --- a/FunctionSpace/FunctionSpaceScalar.h +++ b/FunctionSpace/FunctionSpaceScalar.h @@ -126,6 +126,52 @@ class FunctionSpaceScalar : public FunctionSpace{ @return Returns the @em gradient of the basis functions associated to the given element (with correct @em closure) + ** + + @fn FunctionSpaceScalar::preEvaluateLocalFunctions + @param points A set of @c 3D Points + + Precomputes the Local Functions of this FunctionSpace + at the given Points. + + @note Each row of @c point is a new Point, + and each column is a coordinate (for a total of + 3 columns) + ** + + @fn FunctionSpaceScalar::preEvaluateGradLocalFunctions + @param points A set of @c 3D Points + + Precomputes the @em Gradient of the Local Functions + of this FunctionSpace at the given Points. + + @note Each row of @c point is a new Point, + and each column is a coordinate (for a total of + 3 columns) + ** + + @fn FunctionSpaceScalar::getEvaluatedLocalFunctions + @param element A MElement + @return Returns the @em values of the @em precomputed + Basis Functions associated + to the given element (with correct @em closure) + + @note + The returned values must be computed by + FunctionSpaceScalar::preEvaluateLocalFunctions(), + if not an Exception will be thrown + ** + + @fn FunctionSpaceScalar::getEvaluatedGradLocalFunctions + @param element A MElement + @return Returns the @em values of the @em precomputed + @em Gradients of the Basis Functions associated + to the given element (with correct @em closure) + + @note + The returned values must be computed by + FunctionSpaceScalar::preEvaluateGradLocalFunctions(), + if not an Exception will be thrown */ //////////////////////