---

ParameterExpr.h

Go to the documentation of this file.

#ifndef PARAMETEREXPR_H
#define PARAMETEREXPR_H

#include "SundanceDefs.h"

#include "Expr.h"


namespace Sundance
{

  using namespace TSF;
  using std::string;

  using std::ostream;

  /** \ingroup UserLevelSymbolics
   * An expression that represents a modifiable design parameter.
   */
  class ParameterExpr : public ExprBase
    {
    public:
      /** \name User-level methods */
      //@{
      /** Construct with a name and a value */
      ParameterExpr(const double& value, const string& name = "");
      //@}

      /** \name Developer-only methods */
      //@{
      //* no detailed doc for low-level methods */
        virtual ~ParameterExpr(){;}

        // evaluation
        /** */
        virtual double value() const ;
        /** */
        virtual void setParameterValue(const double& value);

        /** */
        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 PARAMETEREXPR;}

        // RTTI
        /** */
        virtual bool isParameterExpr() const {return true;}

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

        // miscellany
        /** */
        virtual ExprBase* clone() const ;
        /** */
        virtual void print(ostream& os, bool paren=false) const ;
        /** */
        virtual XMLObject toXML() const ;
        /** */
        virtual const string& name() const ;
        //@}
    private:
        double value_;
        string name_;
        static int topID_;
    };

}
#endif

---

Contact:

Kevin Long (krlong@ca.sandia.gov)


Documentation generated by