ConstantScalarFunction Class Reference

#include <ConstantScalarFunction.H>

Inheritance diagram for ConstantScalarFunction:

Inheritance graph
[legend]

List of all members.


Detailed Description

This ScalarFunction subclass represents a function that returns a constant value everywhere in space and time.

Public Member Functions

 ConstantScalarFunction (Real a_value)
 ~ConstantScalarFunction ()
 Destructor.
Real operator() (const RealVect &a_x, Real a_t) const
Real derivative (const IntVect &a_order, const RealVect &a_x, Real a_t) const

Private Attributes

Real m_value

Constructor & Destructor Documentation

ConstantScalarFunction::ConstantScalarFunction ( Real  a_value  )  [explicit]

Creates a constant scalar function returning the given value.

Parameters:
a_value The value returned by the function.

ConstantScalarFunction::~ConstantScalarFunction (  ) 

Destructor.


Member Function Documentation

Real ConstantScalarFunction::operator() ( const RealVect a_x,
Real  a_t 
) const [virtual]

Override this method to evaluate this function at the given point in space and time.

Parameters:
a_x A point in $D$-dimensional space.
a_t The time at which the function is to be evaluated.

Implements ScalarFunction.

Real ConstantScalarFunction::derivative ( const IntVect a_order,
const RealVect a_x,
Real  a_t 
) const [virtual]

Override this method to evaluate the given partial derivative of the function at the given point in space and time.

Parameters:
a_order A multi-index identifying the order(s) of the partial derivative of the function to be evaluated.
a_x A point in $D$-dimensional space.
a_t The time at which the derivative is to be evaluated.

Reimplemented from ScalarFunction.


Member Data Documentation


The documentation for this class was generated from the following file:

Generated on Thu Jul 27 03:42:56 2017 for Chombo + EB by  doxygen 1.5.5