Skip to content
Snippets Groups Projects
Commit 93f64d63 authored by Nicolas Marsic's avatar Nicolas Marsic
Browse files

Doc...

parent 0ebe7289
No related branches found
No related tags found
No related merge requests found
......@@ -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
......
#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;
......
......@@ -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;
......
......@@ -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;
......
......@@ -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
*/
//////////////////////
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment