---

StdFunctionExpr.h

Go to the documentation of this file.

#ifndef STDFUNCTIONEXPR_H
#define STDFUNCTIONEXPR_H

#include "SundanceDefs.h"

#include "UnaryExpr.h"
#include "Expr.h"
#include "DenseSerialVector.h"
#include "XMLObject.h"


namespace Sundance
{

  using namespace TSF;
  using std::string;

  using std::ostream;

  enum StdFunctionCode {StdSin, StdCos, StdExp, StdLog,
                        StdCosh, StdSinh, StdSqrt, StdFabs, StdSign,
                        StdATan, StdACos, StdASin};

  typedef double (*StdFunctionPtr)(double);

  typedef Expr (*StdFuncOfExpr)(const Expr&);

  /** \ingroup LowLevelSymbolics
   * A standard elementary math function operating on a symbolic expression.
   */

  class StdFunctionExpr : public UnaryExpr
    {
    public:
      /** \name Developer-only methods */
      //@{
      /** no detailed doc */
      StdFunctionExpr(StdFunctionCode funcCode, const Expr& arg);
      virtual ~StdFunctionExpr(){;}

      // factory method for building exprs from XML
      /** */
      static bool createFunction(const XMLObject& xml, Expr& result);
      /** */
      static bool oneArgumentFunction(const string& tag, StdFuncOfExpr f,
                                      const XMLObject& xml, Expr& result);



      // evaluation

      /** */
      virtual double value() const ;

      /** */
      virtual void evaluate(const WorkSet& workSet,
                            const QuadratureFamily& quadFamily,
                            DenseSerialVector& result) const ;

      /** */
      virtual void evaluate(const AbstractFunctionSpace& targetSpace, const TSFArray<Cell>& cells,
                            const TSFArray<int>& cellIndices,
                            const TSFArray<int>& dofIndices,
                            const TSFArray<Point>& x,
                            DenseSerialVector& values) const ;


      /** */
      virtual ExprValue average(const Cell& cell) const ;

      // differentiation
      /** */
      virtual void derivative(const MultiIndex& d, Expr& result) const ;

      // ordering support
      /** */
      virtual bool operator==(const Expr& other) const ;
      /** */
      virtual bool operator<(const Expr& other) const ;
      /** */
      virtual int sortPriority() const {return STDFUNCTIONEXPR;}

      /** */
      virtual ExprBase* clone() const ;

      /** */
      virtual bool isSpatiallyConstant() const
        {return expr_.isSpatiallyConstant();}

      /** */
      virtual void print(ostream& os, bool paren=false) const ;
      /** */
      virtual string toString(bool paren=false) const ;
      /** */
      virtual XMLObject toXML() const ;

      /** */
      const string& name() const {return name_;}

      /** extract the mesh */
      virtual bool getMesh(Mesh& mesh) const ;

      /** */
      virtual void differential(const Expr& u, const Expr& du,
                                Expr& result) const ;

      /** */
      virtual void substitute(const Expr& u, const Expr& u0,
                              Expr& result) const ;
      //@}
    protected:
      /** derivative of the function */
      Expr dFunc() const ;

      string name_;
      StdFunctionCode funcCode_;
      StdFunctionPtr funcPtr_;
    };


  /** \relates Expr
      Trigonometric sine function.
  */
  Expr sin(const Expr& arg);

  /** \relates Expr
      Trigonometric cosine function.
  */
  Expr cos(const Expr& arg);

  /** \relates Expr
      Trigonometric tangent function
  */
  Expr tan(const Expr& arg);

  /** \relates Expr
      Trigonometric inverse sine function
  */
  Expr asin(const Expr& arg);

  /** \relates Expr
      Trigonometric inverse cosine function
  */
  Expr acos(const Expr& arg);

  /** \relates Expr
      Trigonometric inverse tangent function
  */
  Expr atan(const Expr& arg);

  /** \relates Expr
      Exponential function
  */
  Expr exp(const Expr& arg);

  /** \relates Expr
      Logarithm function
  */
  Expr log(const Expr& arg);

  /** \relates Expr
      Hyperbolic cosine function
  */
  Expr cosh(const Expr& arg);

  /** \relates Expr
      Hyperbolic sine function
  */
  Expr sinh(const Expr& arg);

  /** \relates Expr
      Hyperbolic tangent function
  */
  Expr tanh(const Expr& arg);

  /** \relates Expr
      Square root function
  */
  Expr sqrt(const Expr& arg);


  /** \relates Expr
      Absolute value function
  */
  Expr fabs(const Expr& arg);

  /** \relates Expr
      Sign function
  */
  Expr sign(const Expr& arg);

}
#endif

---

Contact:

Kevin Long (krlong@ca.sandia.gov)


Documentation generated by