Calculates the natural logarithm of the specified scalar field. More...

Inheritance diagram for log:

Collaboration diagram for log:

Public Member Functions
	TypeName ("log")
	Runtime type information. More...

	log (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

virtual	~log ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the randomise data. More...

Public Member Functions inherited from fieldExpression
	TypeName ("fieldExpression")
	Runtime type information. More...

	fieldExpression (const word &name, const Time &runTime, const dictionary &dict, const word &functionName, const word &defaultFieldName=word::null)
	Construct from Time and dictionary. More...

	fieldExpression (const fieldExpression &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fieldExpression ()
	Destructor. More...

virtual wordList	fields () const
	Return the field required. More...

virtual bool	execute ()
	Calculate the result field. More...

virtual bool	write ()
	Write the result field. More...

virtual bool	clear ()
	Clear the result field from the objectRegistry. More...

void	operator= (const fieldExpression &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information. More...

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

void	operator= (const fvMeshFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information. More...

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextWrite ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Attributes inherited from fieldExpression
const word	fieldName_
	Name of field to process. More...

word	resultName_
	Name of result field. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
const Time &	time_
	Reference to the Time. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Detailed Description

Calculates the natural logarithm of the specified scalar field.

Performs $ln(max(x, a))$ where $x$ is the field and $a$ an optional clip to handle 0 or negative $x$ . Dimension checking can optionally be suspended for this operation if $x$ is dimensioned.

Example of function object specification:

log1
{
    type            log;
    libs            ("libfieldFunctionObjects.so");
    field           p;
    clip            1e-3;
    checkDimensions no;
}

or using postProcess

postProcess -func 'log(p, clip=1e-3, checkDimensions=no)'

Usage

Property	Description	Required
`type`	Type name: log	yes
`clip`	Clip value	no
`checkDimensions`	Dimension checking switch	no

See also: Foam::functionObjects::fieldExpression Foam::functionObjects::fvMeshFunctionObject

Source files

log.H
log.C

Definition at line 103 of file log.H.

Constructor & Destructor Documentation

◆ log()

log	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 93 of file log.C.

References Foam::read().

Here is the call graph for this function:

◆ ~log()

~log ( )

virtual

Destructor.

Definition at line 110 of file log.C.

Member Function Documentation

◆ TypeName()

TypeName ( "log" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the randomise data.

Reimplemented from regionFunctionObject.

Definition at line 116 of file log.C.

References dictionary::found(), dictionary::lookup(), and dictionary::lookupOrDefault().