regularisationRadius Class Reference

Base class for selecting the regulatisation radius. More...

#include <regularisationRadius.H>

Inheritance diagram for regularisationRadius:

Collaboration diagram for regularisationRadius:

Public Member Functions
	TypeName ("regularisationRadius")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, regularisationRadius, dictionary,(const fvMesh &mesh, const dictionary &dict, bool adjustWallThickness),(mesh, dict, adjustWallThickness))
	regularisationRadius (const fvMesh &mesh, const dictionary &dict, bool adjustWallThickness)
	Construct from components.
virtual	~regularisationRadius ()=default
	Destructor.
virtual void	addRegularisationTerm (fvScalarMatrix &matrix, bool isTopoField) const =0
	Term including the regulatisation of the field.

Static Public Member Functions
static autoPtr< regularisationRadius >	New (const fvMesh &mesh, const dictionary &dict, bool adjustWallThickness)
	Construct and return the selected regularisationRadius.

Protected Attributes
const fvMesh &	mesh_
const dictionary	dict_

Detailed Description

Base class for selecting the regulatisation radius.

Source files

• regularisationRadius.H
• regularisationRadius.C

Definition at line 50 of file regularisationRadius.H.

Constructor & Destructor Documentation

regularisationRadius()

regularisationRadius	(	const fvMesh &	mesh,
		const dictionary &	dict,
		bool	adjustWallThickness )

Construct from components.

Definition at line 35 of file regularisationRadius.C.

References dict, dict_, mesh, and mesh_.

~regularisationRadius()

virtual ~regularisationRadius ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"regularisationRadius"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		regularisationRadius	,
		dictionary	,
		(const fvMesh &mesh, const dictionary &dict, bool adjustWallThickness)	,
		(mesh, dict, adjustWallThickness)	)

References dict, and mesh.

New()

Foam::autoPtr< Foam::regularisationRadius > New ( const fvMesh & mesh, const dictionary & dict, bool adjustWallThickness )

static

Construct and return the selected regularisationRadius.

Default to isotropic

Definition at line 49 of file regularisationRadius.C.

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

Here is the call graph for this function:

addRegularisationTerm()

virtual void addRegularisationTerm ( fvScalarMatrix & matrix, bool isTopoField ) const

pure virtual

Term including the regulatisation of the field.

Implemented in isotropic.

Referenced by Helmholtz::solveEqn().

Here is the caller graph for this function:

Member Data Documentation

mesh_

const fvMesh& mesh_

protected

Definition at line 72 of file regularisationRadius.H.

Referenced by isotropic::computeRadius(), and regularisationRadius().

dict_

const dictionary dict_

protected

Definition at line 74 of file regularisationRadius.H.

Referenced by isotropic::isotropic(), and regularisationRadius().

---

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

• src/optimisation/adjointOptimisation/adjoint/optimisation/designVariables/topODesignVariables/regularisation/regularisationRadius/regularisationRadius/regularisationRadius.H
• src/optimisation/adjointOptimisation/adjoint/optimisation/designVariables/topODesignVariables/regularisation/regularisationRadius/regularisationRadius/regularisationRadius.C