sigmoid Class Reference

Inheritance diagram for sigmoid:

Collaboration diagram for sigmoid:

Public Member Functions
	TypeName ("sigmoid")
	Runtime type information. More...
	sigmoid (const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)
	Construct from components. More...
	~sigmoid ()
	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 ()
	Destructor. More...
const dictionary &	energyScalingFunctionProperties () const

Private Member Functions
scalar	sigmoidScale (const scalar r, const scalar shift, const scalar scale) const

Private Attributes
dictionary	sigmoidCoeffs_
scalar	shift_
scalar	scale_

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 &)
	Disallow copy construct. More...
void	operator= (const energyScalingFunction &)
	Disallow default bitwise assignment. More...
Protected Attributes inherited from energyScalingFunction
word	name_
dictionary	energyScalingFunctionProperties_
const pairPotential &	pairPot_

Detailed Description

Source files

• sigmoid.H
• sigmoid.C

Definition at line 50 of file sigmoid.H.

Constructor & Destructor Documentation

sigmoid()

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

Construct from components.

Definition at line 64 of file sigmoid.C.

~sigmoid()

~sigmoid ( )

inline

Destructor.

Definition at line 90 of file sigmoid.H.

Member Function Documentation

sigmoidScale()

scalar sigmoidScale ( const scalar  r, const scalar  shift, const scalar  scale  ) const

private

Definition at line 51 of file sigmoid.C.

References Foam::exp().

Referenced by sigmoid::scaleEnergy().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"sigmoid"

)

Runtime type information.

scaleEnergy()

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

virtual

Implements energyScalingFunction.

Definition at line 82 of file sigmoid.C.

References Foam::e, sigmoid::scale_, sigmoid::shift_, and sigmoid::sigmoidScale().

Here is the call graph for this function:

read()

bool read ( const dictionary &  energyScalingFunctionProperties )

virtual

Read dictionary.

Implements energyScalingFunction.

Definition at line 88 of file sigmoid.C.

References energyScalingFunction::energyScalingFunctionProperties(), dictionary::lookup(), energyScalingFunction::read(), sigmoid::shift_, sigmoid::sigmoidCoeffs_, and dictionary::subDict().

Here is the call graph for this function:

Field Documentation

sigmoidCoeffs_

dictionary sigmoidCoeffs_

private

Definition at line 56 of file sigmoid.H.

Referenced by sigmoid::read().

shift_

scalar shift_

private

Definition at line 58 of file sigmoid.H.

Referenced by sigmoid::read(), and sigmoid::scaleEnergy().

scale_

scalar scale_

private

Definition at line 59 of file sigmoid.H.

Referenced by sigmoid::scaleEnergy().

---

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

• src/lagrangian/molecularDynamics/potential/energyScalingFunction/derived/sigmoid/sigmoid.H
• src/lagrangian/molecularDynamics/potential/energyScalingFunction/derived/sigmoid/sigmoid.C