FreeFOAM The Cross-Platform CFD Toolkit
Public Member Functions
sigmoid Class Reference

#include <potential/sigmoid.H>

Detailed Description

Source files

Definition at line 51 of file sigmoid.H.

+ Inheritance diagram for sigmoid:
+ Collaboration diagram for sigmoid:

List of all members.

Public Member Functions

 TypeName ("sigmoid")
 Runtime type information.
 sigmoid (const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)
 Construct from components.
 ~sigmoid ()
void scaleEnergy (scalar &e, const scalar r) const
bool read (const dictionary &energyScalingFunctionProperties)
 Read dictionary.
- Public Member Functions inherited from energyScalingFunction
 TypeName ("energyScalingFunction")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, energyScalingFunction, dictionary,(const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot),(name, energyScalingFunctionProperties, pairPot))
 energyScalingFunction (const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)
 Construct from components.
virtual ~energyScalingFunction ()
const dictionary & energyScalingFunctionProperties () const

Additional Inherited Members

- Static Public Member Functions inherited from energyScalingFunction
static autoPtr
< energyScalingFunction > 		New (const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)
 Return a reference to the selected viscosity model.
- Protected Member Functions inherited from energyScalingFunction
 energyScalingFunction (const energyScalingFunction &)
 Disallow copy construct.
void operator= (const energyScalingFunction &)
 Disallow default bitwise assignment.
- Protected Attributes inherited from energyScalingFunction
word name_
dictionary energyScalingFunctionProperties_
const pairPotential & pairPot_

Constructor & Destructor Documentation

sigmoid ( const word &  name,
const dictionary &  energyScalingFunctionProperties,
const pairPotential &  pairPot 
)

Construct from components.

Definition at line 64 of file sigmoid.C.

~sigmoid ( )
inline

Definition at line 92 of file sigmoid.H.

Member Function Documentation

TypeName ( "sigmoid"  )

Runtime type information.

void scaleEnergy ( scalar &  e,
const scalar  r 
) const
virtual

Implements energyScalingFunction.

Definition at line 82 of file sigmoid.C.

bool read ( const dictionary &  energyScalingFunctionProperties)
virtual

Read dictionary.

Implements energyScalingFunction.

Definition at line 88 of file sigmoid.C.

References dictionary::lookup(), and dictionary::subDict().

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