FreeFOAM The Cross-Platform CFD Toolkit
energyScalingFunction Class Reference

#include <potential/energyScalingFunction.H>


Detailed Description

+ Inheritance diagram for energyScalingFunction:
+ Collaboration diagram for energyScalingFunction:

List of all members.

Public Member Functions

 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 ()
virtual void scaleEnergy (scalar &e, const scalar r) const =0
const dictionaryenergyScalingFunctionProperties () const
virtual bool read (const dictionary &energyScalingFunctionProperties)=0
 Read energyScalingFunction dictionary.

Static Public Member Functions

static autoPtr
< energyScalingFunction
New (const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)
 Return a reference to the selected viscosity model.

Protected Member Functions

 energyScalingFunction (const energyScalingFunction &)
 Disallow copy construct.
void operator= (const energyScalingFunction &)
 Disallow default bitwise assignment.

Protected Attributes

word name_
dictionary energyScalingFunctionProperties_
const pairPotentialpairPot_

Constructor & Destructor Documentation

Disallow copy construct.

energyScalingFunction ( const word name,
const dictionary energyScalingFunctionProperties,
const pairPotential pairPot 
)

Construct from components.

Definition at line 41 of file energyScalingFunction.C.

virtual ~energyScalingFunction ( )
inlinevirtual

Definition at line 122 of file energyScalingFunction.H.


Member Function Documentation

void operator= ( const energyScalingFunction )
protected

Disallow default bitwise assignment.

TypeName ( "energyScalingFunction"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
energyScalingFunction  ,
dictionary  ,
(const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)  ,
(name, energyScalingFunctionProperties, pairPot)   
)
autoPtr< energyScalingFunction > New ( const word name,
const dictionary energyScalingFunctionProperties,
const pairPotential pairPot 
)
static

Return a reference to the selected viscosity model.

Definition at line 36 of file newEnergyScalingFunction.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), Foam::name(), and Foam::nl.

virtual void scaleEnergy ( scalar &  e,
const scalar  r 
) const
pure virtual
const dictionary& energyScalingFunctionProperties ( ) const
inline
bool read ( const dictionary energyScalingFunctionProperties)
pure virtual

Read energyScalingFunction dictionary.

Implemented in doubleSigmoid, sigmoid, shiftedForce, shifted, and noScaling.

Definition at line 57 of file energyScalingFunction.C.


Member Data Documentation

word name_
protected

Definition at line 60 of file energyScalingFunction.H.

dictionary energyScalingFunctionProperties_
protected
const pairPotential& pairPot_
protected

Definition at line 64 of file energyScalingFunction.H.


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