#include <fieldRegularisation.H>

Collaboration diagram for fieldRegularisation:

[legend]

Public Member Functions
	TypeName ("fieldRegularisation")
	Runtime type information.
	fieldRegularisation (fvMesh &mesh, const scalarField &alpha, const topOZones &zones, const dictionary &dict)
	Construct from components.
virtual	~fieldRegularisation ()=default
	Destructor.
const volScalarField &	beta () const
	Return beta field.
bool	growFromWalls () const
	Grow beta from walls.
bool	shouldRegularise () const
	Should regularisation be executed.
virtual void	updateBeta ()
	Update the beta field.
void	regularise (const scalarField &source, scalarField &result, const bool isTopoField, const regularisationRadius &radius)
	Regularise an externally provided radius.
void	regularise (const scalarField &source, scalarField &result, const bool isTopoField)
	Regularise field (or sensitivities) using a Laplace PDE.
void	postProcessSens (scalarField &sens)
	Update part of fieldRegularisation to the sensitivitiy derivatives.

Protected Attributes
fvMesh &	mesh_
dictionary	dict_
const topOZones &	zones_
	Cell zones related to topology optimisation.
bool	regularise_
	Perform regulaisation on alpha before inputing it on beta?
bool	project_
	Perform the projection (sharpening) step?
autoPtr< regularisationRadius >	radius_
	Smoothing radius.
const scalarField &	alpha_
	Alpha field (design variables of topology optimisation).
autoPtr< volScalarField >	alphaTilda_
	The regularised alpha field, if regulatisation is performed.
autoPtr< topOInterpolationFunction >	sharpenFunction_
	Function used to sharpen the field after regularisation.
autoPtr< regularisationPDE >	regularisationPDE_
	PDE used for the regularisation.
const scalarField &	betaArg_
	Argument of the beta field.
bool	growFromWalls_
	Whether to apply a fixedValue BC or zeroGradient one to alphaTilda, when regularisation is performed.
volScalarField	beta_
	Beta is the field used for all interpolations between fluid and solid in topology optimisation.

Detailed Description

Definition at line 68 of file fieldRegularisation.H.

Constructor & Destructor Documentation

◆ fieldRegularisation()

fieldRegularisation	(	fvMesh &	mesh,
		const scalarField &	alpha,
		const topOZones &	zones,
		const dictionary &	dict )

Construct from components.

Definition at line 36 of file fieldRegularisation.C.

References alpha, alpha_, alphaTilda_, beta_, betaArg_, DebugInfo, dict, dict_, Foam::dimless, Foam::dimTime, Foam::endl(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, growFromWalls_, mesh, mesh_, Foam::New(), Foam::nl, project_, radius_, regularisationPDE_, regularise_, sharpenFunction_, timeName, Foam::Zero, and zones_.

Here is the call graph for this function:

◆ ~fieldRegularisation()

virtual ~fieldRegularisation ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "fieldRegularisation" )

Runtime type information.

References alpha, dict, and mesh.

◆ beta()

const volScalarField & beta ( ) const

inline

Return beta field.

Definition at line 189 of file fieldRegularisation.H.

References beta_.

◆ growFromWalls()

bool growFromWalls ( ) const

inline

Grow beta from walls.

Definition at line 197 of file fieldRegularisation.H.

References growFromWalls_.

◆ shouldRegularise()

bool shouldRegularise ( ) const

inline

Should regularisation be executed.

Definition at line 205 of file fieldRegularisation.H.

References regularise_.

◆ updateBeta()

void updateBeta ( )

virtual

Update the beta field.

Performs regulaisation of alpha_, if necessary

Definition at line 102 of file fieldRegularisation.C.

References alpha_, alphaTilda_, beta_, betaArg_, project_, regularise(), regularise_, and sharpenFunction_.

Here is the call graph for this function:

◆ regularise() [1/2]

void regularise	(	const scalarField &	source,
		scalarField &	result,
		const bool	isTopoField,
		const regularisationRadius &	radius )

Regularise an externally provided radius.

Definition at line 122 of file fieldRegularisation.C.

References alphaTilda_, regularisationPDE_, and regularise().

Referenced by postProcessSens(), regularise(), regularise(), and updateBeta().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ regularise() [2/2]

void regularise	(	const scalarField &	source,
		scalarField &	result,
		const bool	isTopoField )

Regularise field (or sensitivities) using a Laplace PDE.

Definition at line 135 of file fieldRegularisation.C.

References alphaTilda_, radius_, regularisationPDE_, and regularise().

Here is the call graph for this function:

◆ postProcessSens()

void postProcessSens ( scalarField & sens )

Update part of fieldRegularisation to the sensitivitiy derivatives.

Definition at line 147 of file fieldRegularisation.C.

References betaArg_, mesh_, project_, regularise(), regularise_, and sharpenFunction_.

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

fvMesh& mesh_

protected

Definition at line 75 of file fieldRegularisation.H.

Referenced by fieldRegularisation(), and postProcessSens().

◆ dict_

dictionary dict_

protected

Definition at line 76 of file fieldRegularisation.H.

Referenced by fieldRegularisation().

◆ zones_

const topOZones& zones_

protected

Cell zones related to topology optimisation.

Definition at line 81 of file fieldRegularisation.H.

Referenced by fieldRegularisation().

◆ regularise_

bool regularise_

protected

Perform regulaisation on alpha before inputing it on beta?

Definition at line 86 of file fieldRegularisation.H.

Referenced by fieldRegularisation(), postProcessSens(), shouldRegularise(), and updateBeta().

◆ project_

bool project_

protected

Perform the projection (sharpening) step?

Definition at line 91 of file fieldRegularisation.H.

Referenced by fieldRegularisation(), postProcessSens(), and updateBeta().

◆ radius_

autoPtr<regularisationRadius> radius_

protected

Smoothing radius.

May be isotropic or differ per spatial direction

Definition at line 98 of file fieldRegularisation.H.

Referenced by fieldRegularisation(), and regularise().

◆ alpha_

const scalarField& alpha_

protected

Alpha field (design variables of topology optimisation).

Definition at line 103 of file fieldRegularisation.H.

Referenced by fieldRegularisation(), and updateBeta().

◆ alphaTilda_

autoPtr<volScalarField> alphaTilda_

protected

The regularised alpha field, if regulatisation is performed.

Definition at line 108 of file fieldRegularisation.H.

Referenced by fieldRegularisation(), regularise(), regularise(), and updateBeta().

◆ sharpenFunction_

autoPtr<topOInterpolationFunction> sharpenFunction_

protected

Function used to sharpen the field after regularisation.

Definition at line 113 of file fieldRegularisation.H.

Referenced by fieldRegularisation(), postProcessSens(), and updateBeta().

◆ regularisationPDE_

autoPtr<regularisationPDE> regularisationPDE_

protected

PDE used for the regularisation.

Definition at line 118 of file fieldRegularisation.H.

Referenced by fieldRegularisation(), regularise(), and regularise().

◆ betaArg_

const scalarField& betaArg_

protected

Argument of the beta field.

Is either alpha_ (no regularisation) or alphaTilda_ (with regularisation)

Definition at line 126 of file fieldRegularisation.H.

Referenced by fieldRegularisation(), postProcessSens(), and updateBeta().

◆ growFromWalls_

bool growFromWalls_

protected

Whether to apply a fixedValue BC or zeroGradient one to alphaTilda, when regularisation is performed.

Definition at line 132 of file fieldRegularisation.H.

Referenced by fieldRegularisation(), and growFromWalls().

◆ beta_

volScalarField beta_

protected

Beta is the field used for all interpolations between fluid and solid in topology optimisation.

Definition at line 138 of file fieldRegularisation.H.

Referenced by beta(), fieldRegularisation(), and updateBeta().

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

src/optimisation/adjointOptimisation/adjoint/optimisation/designVariables/topODesignVariables/regularisation/fieldRegularisation.H
src/optimisation/adjointOptimisation/adjoint/optimisation/designVariables/topODesignVariables/regularisation/fieldRegularisation.C

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ fieldRegularisation()

◆ ~fieldRegularisation()

Member Function Documentation

◆ TypeName()

◆ beta()

◆ growFromWalls()

◆ shouldRegularise()

◆ updateBeta()

◆ regularise() [1/2]

◆ regularise() [2/2]

◆ postProcessSens()

Member Data Documentation

◆ mesh_

◆ dict_

◆ zones_

◆ regularise_

◆ project_

◆ radius_

◆ alpha_

◆ alphaTilda_

◆ sharpenFunction_

◆ regularisationPDE_

◆ betaArg_

◆ growFromWalls_

◆ beta_