Gadget
Public Member Functions | List of all members
ExpSelectFunc Class Reference

This is the class used to calculate the selection level based on an exponential function of length. More...

#include <selectfunc.h>

Inheritance diagram for ExpSelectFunc:
Inheritance graph
Collaboration diagram for ExpSelectFunc:
Collaboration graph

Public Member Functions

 ExpSelectFunc ()
 This is the ExpSelectFunc constructor. More...
 
virtual ~ExpSelectFunc ()
 This is the default ExpSelectFunc destructor. More...
 
virtual double calculate (double len)
 This will return the selection level that has been calculated. More...
 
- Public Member Functions inherited from SelectFunc
 SelectFunc (const char *givenname)
 This is the default SelectFunc constructor. More...
 
virtual ~SelectFunc ()
 This is the default SelectFunc destructor. More...
 
void readConstants (CommentStream &infile, const TimeClass *const TimeInfo, Keeper *const keeper)
 This function will read the value of the selection function parameters from file. More...
 
void updateConstants (const TimeClass *const TimeInfo)
 This function will update the selection function parameters. More...
 
int didChange (const TimeClass *const TimeInfo)
 This function will check to see if the selection function parameters have changed. More...
 
int numConstants ()
 This will return the number of constants used to calculate the selection value. More...
 
- Public Member Functions inherited from HasName
 HasName ()
 This is the default HasName constructor. More...
 
virtual ~HasName ()
 This is the default HasName destructor. More...
 
 HasName (const char *givenname)
 This is the HasName constructor for a specified name. More...
 
const char * getName () const
 This will return a null terminated text string containing the name of the object. More...
 

Additional Inherited Members

- Protected Attributes inherited from SelectFunc
ModelVariableVector coeff
 This is the ModelVariableVector of the selection function constants. More...
 

Detailed Description

This is the class used to calculate the selection level based on an exponential function of length.

Constructor & Destructor Documentation

◆ ExpSelectFunc()

ExpSelectFunc::ExpSelectFunc ( )

This is the ExpSelectFunc constructor.

◆ ~ExpSelectFunc()

virtual ExpSelectFunc::~ExpSelectFunc ( )
inlinevirtual

This is the default ExpSelectFunc destructor.

Member Function Documentation

◆ calculate()

double ExpSelectFunc::calculate ( double  len)
virtual

This will return the selection level that has been calculated.

Parameters
lenis the length of the length class that is selected
Returns
selection level

Implements SelectFunc.


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