h o m e d o c u m e n t a t i o n c l a s s h i e r a r c h y

LocalAverageDepthF1D Class Reference

#include <AdvancedFunctions1D.h>

Inheritance diagram for LocalAverageDepthF1D:

UnaryFunction1D< double > List of all members.

Detailed Description

Returns the average depth evaluated for an Interface1D. The average depth is evaluated for a set of points along the Interface1D (using the LocalAverageDepthF0D functor) with a user-defined sampling and then integrated into a single value using a user-defined integration method.


Public Member Functions

 LocalAverageDepthF1D (real sigma, IntegrationType iType=MEAN)
string getName () const
double operator() (Interface1D &inter)

Constructor & Destructor Documentation

LocalAverageDepthF1D (  real  sigma,
IntegrationType  iType = MEAN
)  [inline]
 

Builds the functor.

Parameters:
sigma The sigma used in DensityF0D and determining the window size used in each density query.
iType The integration method used to compute a single value from a set of values.

Member Function Documentation

string getName (   )  const [inline, virtual]
 

Returns the string "LocalAverageDepthF1D"

Reimplemented from UnaryFunction1D< double >.

double operator() (  Interface1D &  inter  )  [inline, virtual]
 

the () operator.

Reimplemented from UnaryFunction1D< double >.

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