Loading...
Searching...
No Matches
energyScalingFunction Class Referenceabstract

#include <energyScalingFunction.H>

Inheritance diagram for energyScalingFunction:
Inheritance graph
[legend]
Collaboration diagram for energyScalingFunction:
Collaboration graph
[legend]

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 ()=default
 Destructor.
virtual void scaleEnergy (scalar &e, const scalar r) const =0
const dictionary & energyScalingFunctionProperties () 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 &)=delete
 No copy construct.
void operator= (const energyScalingFunction &)=delete
 No copy assignment.

Protected Attributes

word name_
dictionary energyScalingFunctionProperties_
const pairPotential & pairPot_

Detailed Description

Source files

Definition at line 51 of file energyScalingFunction.H.

Constructor & Destructor Documentation

◆ energyScalingFunction() [1/2]

energyScalingFunction ( const energyScalingFunction & )
protecteddelete

No copy construct.

References energyScalingFunction().

Referenced by declareRunTimeSelectionTable(), doubleSigmoid::doubleSigmoid(), energyScalingFunction(), noScaling::noScaling(), operator=(), shifted::shifted(), shiftedForce::shiftedForce(), and sigmoid::sigmoid().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ energyScalingFunction() [2/2]

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

Construct from components.

Definition at line 34 of file energyScalingFunction.C.

References energyScalingFunctionProperties(), energyScalingFunctionProperties_, Foam::name(), name_, and pairPot_.

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.

References energyScalingFunction().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "energyScalingFunction" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

References energyScalingFunction(), energyScalingFunctionProperties(), and Foam::name().

Here is the call graph for this function:

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

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

Referenced by pairPotential::scaleEnergy().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ scaleEnergy()

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

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

References e.

◆ energyScalingFunctionProperties()

const dictionary & energyScalingFunctionProperties ( ) const
inline

Definition at line 138 of file energyScalingFunction.H.

References energyScalingFunctionProperties_.

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

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 50 of file energyScalingFunction.C.

References energyScalingFunctionProperties(), and energyScalingFunctionProperties_.

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

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ name_

word name_
protected

Definition at line 58 of file energyScalingFunction.H.

Referenced by energyScalingFunction().

◆ energyScalingFunctionProperties_

dictionary energyScalingFunctionProperties_
protected

Definition at line 60 of file energyScalingFunction.H.

Referenced by energyScalingFunction(), energyScalingFunctionProperties(), and read().

◆ pairPot_

const pairPotential& pairPot_
protected

Definition at line 62 of file energyScalingFunction.H.

Referenced by energyScalingFunction().

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