Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
energyScalingFunction Class Referenceabstract
Inheritance diagram for energyScalingFunction:
[legend]
Collaboration diagram for energyScalingFunction:
[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 ()=default
 Destructor. More...
 
virtual void scaleEnergy (scalar &e, const scalar r) const =0
 
const dictionary & energyScalingFunctionProperties () const
 
virtual bool read (const dictionary &energyScalingFunctionProperties)=0
 Read energyScalingFunction dictionary. More...
 

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. More...
 

Protected Member Functions

 energyScalingFunction (const energyScalingFunction &)=delete
 No copy construct. More...
 
void operator= (const energyScalingFunction &)=delete
 No copy assignment. More...
 

Protected Attributes

word name_
 
dictionary energyScalingFunctionProperties_
 
const pairPotential & pairPot_
 

Detailed Description

Source files

Definition at line 55 of file energyScalingFunction.H.

Constructor & Destructor Documentation

◆ energyScalingFunction() [1/2]

energyScalingFunction ( const energyScalingFunction &  )
protecteddelete

No copy construct.

◆ energyScalingFunction() [2/2]

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

Construct from components.

Definition at line 41 of file energyScalingFunction.C.

References Foam::name().

Here is the call graph for this function:

◆ ~energyScalingFunction()

virtual ~energyScalingFunction ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const energyScalingFunction &  )
protecteddelete

No copy assignment.

◆ TypeName()

TypeName ( "energyScalingFunction"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
energyScalingFunction  ,
dictionary  ,
(const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)  ,
(name, energyScalingFunctionProperties, pairPot)   
)

◆ New()

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 34 of file energyScalingFunctionNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), Foam::Info, and Foam::name().

Here is the call graph for this function:

◆ scaleEnergy()

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

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

Referenced by pairPotential::scaleEnergy().

Here is the caller graph for this function:

◆ energyScalingFunctionProperties()

const dictionary & energyScalingFunctionProperties ( ) const
inline

Definition at line 130 of file energyScalingFunction.H.

References energyScalingFunction::energyScalingFunctionProperties_.

Referenced by doubleSigmoid::read(), noScaling::read(), shifted::read(), shiftedForce::read(), and sigmoid::read().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary &  energyScalingFunctionProperties)
pure virtual

Read energyScalingFunction dictionary.

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

Definition at line 57 of file energyScalingFunction.C.

Member Data Documentation

◆ name_

word name_
protected

Definition at line 62 of file energyScalingFunction.H.

◆ energyScalingFunctionProperties_

dictionary energyScalingFunctionProperties_
protected

Definition at line 64 of file energyScalingFunction.H.

Referenced by energyScalingFunction::energyScalingFunctionProperties().

◆ pairPot_

const pairPotential& pairPot_
protected

Definition at line 66 of file energyScalingFunction.H.

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