Skip to content

Commit

Permalink
Added some more comments and conveience constructors
Browse files Browse the repository at this point in the history
  • Loading branch information
motion committed May 8, 2016
1 parent 60768ef commit 1311742
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion math/vectorfunction.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@ namespace Math {
/** @addtogroup Math */
/*@{*/

///@brief
///A function g(t) that returns f(x+tn) for a scalar field f(x)
///If ref is true, then x,n are set to refer to the x,n provided in
///the constructor.
///the constructor, rather than to copy.
///
///Note that this object is only valid for the duration that f
///is valid.
class ScalarFieldDirectionalFunction : public RealFunction
{
public:
Expand All @@ -42,6 +46,9 @@ class ScalarFieldDirectionalFunction : public RealFunction
///A function g(t) that returns f(x+t*ei), where ei is the ith standard
///basis vector.
///If ref is true, then x is set to refer to the x provided in the constructor.
///
///Note that this object is only valid for the duration that f
///is valid.
class ScalarFieldProjectionFunction : public RealFunction
{
public:
Expand Down Expand Up @@ -337,6 +344,9 @@ class VectorFieldProjectionFunction : public ScalarFieldFunction
class CompositeVectorFieldFunction : public VectorFieldFunction
{
public:
CompositeVectorFieldFunction();
CompositeVectorFieldFunction(SmartPointer<VectorFieldFunction> f1,SmartPointer<VectorFieldFunction>& f2);
CompositeVectorFieldFunction(const std::vector<SmartPointer<VectorFieldFunction> >& fs);
virtual std::string Label() const;
virtual std::string Label(int i) const;
virtual int NumDimensions() const;
Expand Down

0 comments on commit 1311742

Please sign in to comment.