Public Member Functions | List of all members
doubleSigmoid Class Reference
Inheritance diagram for doubleSigmoid:
[legend]
Collaboration diagram for doubleSigmoid:
[legend]

Public Member Functions

 TypeName ("doubleSigmoid")
 Runtime type information. More...
 
 doubleSigmoid (const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)
 Construct from components. More...
 
 ~doubleSigmoid ()
 Destructor. More...
 
void scaleEnergy (scalar &e, const scalar r) const
 
bool read (const dictionary &energyScalingFunctionProperties)
 Read dictionary. More...
 
- Public Member Functions inherited from energyScalingFunction
 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...
 
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. More...
 
- Protected Member Functions inherited from energyScalingFunction
 energyScalingFunction (const energyScalingFunction &)=delete
 No copy construct. More...
 
void operator= (const energyScalingFunction &)=delete
 No copy assignment. More...
 
- Protected Attributes inherited from energyScalingFunction
word name_
 
dictionary energyScalingFunctionProperties_
 
const pairPotential & pairPot_
 

Detailed Description

Source files

Definition at line 52 of file doubleSigmoid.H.

Constructor & Destructor Documentation

◆ doubleSigmoid()

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

Construct from components.

Definition at line 65 of file doubleSigmoid.C.

◆ ~doubleSigmoid()

~doubleSigmoid ( )
inline

Destructor.

Definition at line 94 of file doubleSigmoid.H.

Member Function Documentation

◆ TypeName()

TypeName ( "doubleSigmoid"  )

Runtime type information.

◆ scaleEnergy()

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

Implements energyScalingFunction.

Definition at line 85 of file doubleSigmoid.C.

References Foam::constant::electromagnetic::e.

◆ read()

bool read ( const dictionary &  energyScalingFunctionProperties)
virtual

Read dictionary.

Implements energyScalingFunction.

Definition at line 91 of file doubleSigmoid.C.

References energyScalingFunction::energyScalingFunctionProperties(), energyScalingFunction::read(), dictionary::readEntry(), and dictionary::subDict().

Here is the call graph for this function:
The documentation for this class was generated from the following files: