SundanceSymbolicFunc.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                             Sundance
//                 Copyright 2011 Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Kevin Long (kevin.long@ttu.edu)
// 

/* @HEADER@ */

#ifndef SUNDANCE_SYMBOLICFUNC_H
#define SUNDANCE_SYMBOLICFUNC_H


#include "SundanceDefs.hpp"
#include "SundanceListExpr.hpp"
#include "SundanceSymbolicFuncDescriptor.hpp"
#include "SundanceFunctionWithID.hpp"
#include "SundanceDiscreteFuncElement.hpp"
#include "SundanceDiscreteFunctionStub.hpp"

namespace Sundance
{
using namespace Sundance;
using namespace Teuchos;
    

/** 
 * SymbolicFunc is a base class for functions such as test and unknown
 * functions that are "variables" in a weak form. Symbolic functions
 * cannot be evaluated directly; before evaluating a weak form,
 a value must be substituted for 
 * each symbolic func using either the substituteZero() or
 * substituteFunction() method. 
 *
 * A symbolic function will construct itself as a list of
 * SymbolicFuncElement objects that point back to the SymbolicFunction.
 */
class SymbolicFunc : public ListExpr, public SymbolicFuncDescriptor,
  public FunctionWithID
{
public:
  /** Ctor records common data but initializes list to empty */
  SymbolicFunc(const FunctionWithID& fid, 
    const RCP<const CommonFuncDataStub>& data);

  /** virtual destructor */
  virtual ~SymbolicFunc() {;}

  /** Specify that expressions involving this function are to be evaluated
   * with this function set to zero. This is appropriate for computing
   * the functional derivatives that arise in a linear problem */
  void substituteZero() const ;

  /** Specify that expressions involving this function are to be evaluated
   * with this function set to the discrete function \f$u_0\f$. 
   * This is appropriate for computing
   * the functional derivatives that arise in a nonlinear expression
   * being linearized about \f$u_0\f$. 
   */
  void substituteFunction(const RCP<DiscreteFunctionStub>& u0) const ;

  /** */
  const RCP<const CommonFuncDataStub>& commonData() const 
    {return commonData_;}
  

private:
  RCP<const CommonFuncDataStub> commonData_;

};
}


#endif