doubleSigmoid Class Reference

Inheritance diagram for doubleSigmoid:

Collaboration diagram for doubleSigmoid:

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 ()
	Destructor. More...
const dictionary &	energyScalingFunctionProperties () const

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

Private Attributes
dictionary	doubleSigmoidCoeffs_
scalar	shift1_
scalar	scale1_
scalar	shift2_
scalar	scale2_

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

• doubleSigmoid.H
• doubleSigmoid.C

Definition at line 50 of file doubleSigmoid.H.

Constructor & Destructor Documentation

doubleSigmoid()

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

Construct from components.

Definition at line 63 of file doubleSigmoid.C.

~doubleSigmoid()

~doubleSigmoid ( )

inline

Destructor.

Definition at line 92 of file doubleSigmoid.H.

Member Function Documentation

sigmoidScale()

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

private

Definition at line 50 of file doubleSigmoid.C.

References Foam::exp().

Referenced by doubleSigmoid::scaleEnergy().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"doubleSigmoid"

)

Runtime type information.

scaleEnergy()

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

virtual

Implements energyScalingFunction.

Definition at line 83 of file doubleSigmoid.C.

References Foam::e, doubleSigmoid::scale1_, doubleSigmoid::scale2_, doubleSigmoid::shift1_, doubleSigmoid::shift2_, and doubleSigmoid::sigmoidScale().

Here is the call graph for this function:

read()

bool read ( const dictionary &  energyScalingFunctionProperties )

virtual

Read dictionary.

Implements energyScalingFunction.

Definition at line 89 of file doubleSigmoid.C.

References doubleSigmoid::doubleSigmoidCoeffs_, energyScalingFunction::energyScalingFunctionProperties(), dictionary::lookup(), energyScalingFunction::read(), doubleSigmoid::scale1_, doubleSigmoid::scale2_, doubleSigmoid::shift1_, doubleSigmoid::shift2_, and dictionary::subDict().

Here is the call graph for this function:

Field Documentation

doubleSigmoidCoeffs_

dictionary doubleSigmoidCoeffs_

private

Definition at line 56 of file doubleSigmoid.H.

Referenced by doubleSigmoid::read().

shift1_

scalar shift1_

private

Definition at line 58 of file doubleSigmoid.H.

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

scale1_

scalar scale1_

private

Definition at line 59 of file doubleSigmoid.H.

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

shift2_

scalar shift2_

private

Definition at line 60 of file doubleSigmoid.H.

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

scale2_

scalar scale2_

private

Definition at line 61 of file doubleSigmoid.H.

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

---

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

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