topOInterpolationFunction Class Reference

#include <topOInterpolationFunction.H>

Inheritance diagram for topOInterpolationFunction:

Collaboration diagram for topOInterpolationFunction:

Public Member Functions
	TypeName ("topOInterpolationFunction")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, topOInterpolationFunction, dictionary,(const fvMesh &mesh, const dictionary &dict),(mesh, dict))
	topOInterpolationFunction (const fvMesh &mesh, const dictionary &dict)
	Construct from components.
virtual	~topOInterpolationFunction ()=default
	Destructor.
virtual void	interpolate (const scalarField &arg, scalarField &res) const =0
	Interpolate argument to result.
virtual tmp< scalarField >	derivative (const scalarField &arg) const =0
	Return of function with respect to the argument field.
virtual void	setLengthScaleParam (const scalar lengthScale)
	Set the parameter determining length scale.

Static Public Member Functions
static autoPtr< topOInterpolationFunction >	New (const fvMesh &mesh, const dictionary &dict)
	Return an autoPtr to the selected interpolation type.

Protected Attributes
const fvMesh &	mesh_
dictionary	dict_

Detailed Description

Definition at line 50 of file topOInterpolationFunction.H.

Constructor & Destructor Documentation

topOInterpolationFunction()

topOInterpolationFunction	(	const fvMesh &	mesh,
		const dictionary &	dict )

Construct from components.

Definition at line 36 of file topOInterpolationFunction.C.

References dict, dict_, mesh, and mesh_.

~topOInterpolationFunction()

virtual ~topOInterpolationFunction ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"topOInterpolationFunction"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		topOInterpolationFunction	,
		dictionary	,
		(const fvMesh &mesh, const dictionary &dict)	,
		(mesh, dict)	)

References dict, and mesh.

New()

Foam::autoPtr< Foam::topOInterpolationFunction > New ( const fvMesh & mesh, const dictionary & dict )

static

Return an autoPtr to the selected interpolation type.

Definition at line 50 of file topOInterpolationFunction.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and mesh.

Referenced by BorrvallPeterssonInterpolation::BorrvallPeterssonInterpolation(), expInterpolation::expInterpolation(), invBP::invBP(), SIMPInterpolation::SIMPInterpolation(), sinhInterpolation::sinhInterpolation(), smoothHeaviside::smoothHeaviside(), and tanhInterpolation::tanhInterpolation().

Here is the call graph for this function:

Here is the caller graph for this function:

interpolate()

virtual void interpolate ( const scalarField & arg, scalarField & res ) const

pure virtual

Interpolate argument to result.

Implemented in BorrvallPeterssonInterpolation, expInterpolation, invBP, linearInterpolation, sigmoidalHeaviside, SIMPInterpolation, sinhInterpolation, smoothHeaviside, and tanhInterpolation.

Referenced by topODesignVariables::interpolate(), topODesignVariables::nullifyInSolid(), topODesignVariables::penalty(), and topOVariablesBase::sourceTerm().

Here is the caller graph for this function:

derivative()

virtual tmp< scalarField > derivative ( const scalarField & arg ) const

pure virtual

Return of function with respect to the argument field.

Implemented in BorrvallPeterssonInterpolation, expInterpolation, invBP, linearInterpolation, sigmoidalHeaviside, SIMPInterpolation, sinhInterpolation, smoothHeaviside, and tanhInterpolation.

Referenced by topODesignVariables::interpolationSensitivities(), topODesignVariables::nullifyInSolidSensitivities(), topODesignVariables::penaltySensitivities(), and topOVariablesBase::sourceTermSensitivities().

Here is the caller graph for this function:

setLengthScaleParam()

void setLengthScaleParam ( const scalar lengthScale )

virtual

Set the parameter determining length scale.

Warning if the selected interpolation function has no such param

Reimplemented in tanhInterpolation.

Definition at line 79 of file topOInterpolationFunction.C.

References Foam::endl(), Foam::type(), and WarningInFunction.

Here is the call graph for this function:

Member Data Documentation

mesh_

const fvMesh& mesh_

protected

Definition at line 57 of file topOInterpolationFunction.H.

Referenced by sigmoidalHeaviside::computeNearBandWidth(), BorrvallPeterssonInterpolation::derivative(), expInterpolation::derivative(), invBP::derivative(), sigmoidalHeaviside::derivative(), SIMPInterpolation::derivative(), sinhInterpolation::derivative(), smoothHeaviside::derivative(), tanhInterpolation::derivative(), BorrvallPeterssonInterpolation::interpolate(), expInterpolation::interpolate(), invBP::interpolate(), sigmoidalHeaviside::interpolate(), SIMPInterpolation::interpolate(), sinhInterpolation::interpolate(), smoothHeaviside::interpolate(), tanhInterpolation::interpolate(), and topOInterpolationFunction().

dict_

dictionary dict_

protected

Definition at line 59 of file topOInterpolationFunction.H.

Referenced by sigmoidalHeaviside::computeNearBandWidth(), and topOInterpolationFunction().

---

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

• src/optimisation/adjointOptimisation/adjoint/optimisation/designVariables/topODesignVariables/interpolationFunctions/interpolationFunction/topOInterpolationFunction.H
• src/optimisation/adjointOptimisation/adjoint/optimisation/designVariables/topODesignVariables/interpolationFunctions/interpolationFunction/topOInterpolationFunction.C