Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
energyScalingFunction Class Referenceabstract
Inheritance diagram for energyScalingFunction:
Inheritance graph
[legend]
Collaboration diagram for energyScalingFunction:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("energyScalingFunction")
 Runtime type information. More...
 
 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. More...
 
virtual ~energyScalingFunction ()
 Destructor. More...
 
virtual void scaleEnergy (scalar &e, const scalar r) const =0
 
const dictionaryenergyScalingFunctionProperties () const
 
virtual bool read (const dictionary &energyScalingFunctionProperties)=0
 Read energyScalingFunction dictionary. More...
 

Static Public Member Functions

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

Protected Member Functions

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

Protected Attributes

word name_
 
dictionary energyScalingFunctionProperties_
 
const pairPotentialpairPot_
 

Detailed Description

Source files

Definition at line 52 of file energyScalingFunction.H.

Constructor & Destructor Documentation

Disallow copy construct.

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

Construct from components.

Definition at line 40 of file energyScalingFunction.C.

References energyScalingFunction::read().

Here is the call graph for this function:

virtual ~energyScalingFunction ( )
inlinevirtual

Destructor.

Definition at line 120 of file energyScalingFunction.H.

References Foam::e, and energyScalingFunction::scaleEnergy().

Here is the call graph for this function:

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)   
)
Foam::autoPtr< Foam::energyScalingFunction > New ( const word name,
const dictionary energyScalingFunctionProperties,
const pairPotential pairPot 
)
static

Return a reference to the selected viscosity model.

Definition at line 32 of file energyScalingFunctionNew.C.

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

Referenced by pairPotential::scaleEnergy().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Referenced by energyScalingFunction::~energyScalingFunction().

Here is the caller graph for this function:

const dictionary& energyScalingFunctionProperties ( ) const
inline

Definition at line 128 of file energyScalingFunction.H.

References energyScalingFunction::energyScalingFunctionProperties_, and energyScalingFunction::read().

Here is the call graph for this function:

bool read ( const dictionary energyScalingFunctionProperties)
pure virtual

Member Data Documentation

word name_
protected

Definition at line 59 of file energyScalingFunction.H.

dictionary energyScalingFunctionProperties_
protected
const pairPotential& pairPot_
protected

Definition at line 63 of file energyScalingFunction.H.


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