Function.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
#include "MooseObject.h"
#include "SetupInterface.h"
#include "TransientInterface.h"
#include "PostprocessorInterface.h"
#include "UserObjectInterface.h"
#include "Restartable.h"
#include "MeshChangedInterface.h"
#include "ScalarCoupleable.h"
 
// libMesh
#include "libmesh/vector_value.h"
 
// Forward declarations
class Function;
 
// libMesh forward declarations
namespace libMesh
{
class Point;
}
 
template <>
InputParameters validParams<Function>();
 
class Function : public MooseObject,
                 public SetupInterface,
                 public TransientInterface,
                 public PostprocessorInterface,
                 public UserObjectInterface,
                 public Restartable,
                 public MeshChangedInterface,
                 public ScalarCoupleable
{
public:
  static InputParameters validParams();
 
  Function(const InputParameters & parameters);
 
  virtual ~Function();
 
  virtual Real value(Real t, const Point & p) const;
 
  virtual RealVectorValue vectorValue(Real t, const Point & p) const;
 
  virtual RealVectorValue vectorCurl(Real t, const Point & p) const;
 
  virtual RealGradient gradient(Real t, const Point & p) const;
 
  virtual Real timeDerivative(Real t, const Point & p) const;
 
  // Not defined
  virtual Real integral() const;
 
  // Not defined
  virtual Real average() const;
};