sigmoid Class Reference

#include <sigmoid.H>

Inheritance diagram for sigmoid:

Collaboration diagram for sigmoid:

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

Detailed Description

Source files

• sigmoid.H
• sigmoid.C

Definition at line 48 of file sigmoid.H.

Constructor & Destructor Documentation

sigmoid()

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

Construct from components.

Definition at line 58 of file sigmoid.C.

References energyScalingFunction::energyScalingFunction(), energyScalingFunction::energyScalingFunctionProperties(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, and Foam::name().

Here is the call graph for this function:

~sigmoid()

~sigmoid ( )

inline

Destructor.

Definition at line 94 of file sigmoid.H.

Member Function Documentation

TypeName()

TypeName

(

"sigmoid"

)

Runtime type information.

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

Here is the call graph for this function:

scaleEnergy()

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

virtual

Implements energyScalingFunction.

Definition at line 77 of file sigmoid.C.

References e.

read()

bool read ( const dictionary & energyScalingFunctionProperties )

virtual

Read dictionary.

Implements energyScalingFunction.

Definition at line 83 of file sigmoid.C.

References energyScalingFunction::energyScalingFunctionProperties(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, and energyScalingFunction::read().

Here is the call graph for this function:

---

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