#include <topOZones.H>

Collaboration diagram for topOZones:

[legend]

Public Member Functions
	TypeName ("topOZones")
	Runtime type information.
	topOZones (const fvMesh &mesh, const dictionary &dict)
	Construct from components.
virtual	~topOZones ()=default
	Destructor.
const fvMesh &	mesh () const
	Const reference to mesh.
const labelList &	fixedPorousZoneIDs () const
	Cell zone IDs with fixed porosity values.
const scalarList &	fixedPorousValues () const
	Values of alpha for each fixed porous zone.
const labelList &	fixedZeroPorousZoneIDs () const
	Cell zone IDs with fixed zero porosity values.
const labelList &	adjointPorousZoneIDs () const
	Cell zone IDs in which porosity is allowed to change.
const cellZone &	IOCells () const
	Cells next to IO boundaries.
label	IOzoneID () const
	ID of the cellZone holding the IOcells.
scalar	getBetaMax () const
	Get betaMax.

Protected Member Functions
labelList	getZoneIDs (const dictionary &dict, const word &zoneGroup)
	Get zone IDs corresponding to a wordList, read from a dict.
void	addIOcellsZone ()
	Add a cellZone containing the cells next to IO patches.

Protected Attributes
const fvMesh &	mesh_
	Mesh reference.
const dictionary	dict_
	TopO design variables dictionary.
labelList	fixedPorousIDs_
	IDs of cellZones holding cells with constant alpha values.
scalarList	fixedPorousValues_
	The constant alpha values of fixedPorousIDs_.
labelList	fixedZeroPorousIDs_
	IDs of cellZones holding cells with zero alpha values.
labelList	adjointPorousIDs_
	IDs of cellZones with cells that can change their alpha value throughout the optimisation.
label	IOcellsID_
	ID of the cellZone holding the cells next to inlets & outlets.
autoPtr< betaMax >	betaMaxPtr_
	The multiplier of the Brinkman penalisation term.

Detailed Description

Definition at line 49 of file topOZones.H.

Constructor & Destructor Documentation

◆ topOZones()

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

Construct from components.

Definition at line 77 of file topOZones.C.

References addIOcellsZone(), adjointPorousIDs_, betaMaxPtr_, dict, dict_, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, fixedPorousIDs_, fixedPorousValues_, fixedZeroPorousIDs_, getZoneIDs(), IOcellsID_, mesh(), mesh_, and Foam::New().

Here is the call graph for this function:

◆ ~topOZones()

virtual ~topOZones ( )

virtualdefault

Destructor.

Member Function Documentation

◆ getZoneIDs()

Foam::labelList getZoneIDs	(	const dictionary &	dict,
		const word &	zoneGroup )

protected

Get zone IDs corresponding to a wordList, read from a dict.

Avoid going through ZoneMesh.indices() since this practically sorts the IDs from smallest to largest while we need to keep them in the same order as that prescribed in the wordList

Definition at line 35 of file topOZones.C.

References dict, forAll, mesh_, and UList< T >::size().

Referenced by topOZones().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addIOcellsZone()

void addIOcellsZone ( )

protected

Add a cellZone containing the cells next to IO patches.

Definition at line 51 of file topOZones.C.

References DynamicList< T, SizeMin >::append(), IOcellsID_, mesh_, UPtrList< T >::size(), and regIOobject::write().

Referenced by topOZones().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "topOZones" )

Runtime type information.

References dict, and mesh().

Here is the call graph for this function:

◆ mesh()

const fvMesh & mesh ( ) const

inline

Const reference to mesh.

Definition at line 161 of file topOZones.H.

References mesh_.

Referenced by topOZones(), and TypeName().

Here is the caller graph for this function:

◆ fixedPorousZoneIDs()

const labelList & fixedPorousZoneIDs ( ) const

inline

Cell zone IDs with fixed porosity values.

Definition at line 169 of file topOZones.H.

References fixedPorousIDs_.

◆ fixedPorousValues()

const scalarList & fixedPorousValues ( ) const

inline

Values of alpha for each fixed porous zone.

Definition at line 177 of file topOZones.H.

References fixedPorousValues_.

◆ fixedZeroPorousZoneIDs()

const labelList & fixedZeroPorousZoneIDs ( ) const

inline

Cell zone IDs with fixed zero porosity values.

Definition at line 185 of file topOZones.H.

References fixedZeroPorousIDs_.

◆ adjointPorousZoneIDs()

const labelList & adjointPorousZoneIDs ( ) const

inline

Cell zone IDs in which porosity is allowed to change.

Definition at line 193 of file topOZones.H.

References adjointPorousIDs_.

◆ IOCells()

const cellZone & IOCells ( ) const

inline

Cells next to IO boundaries.

Definition at line 201 of file topOZones.H.

References IOcellsID_, and mesh_.

◆ IOzoneID()

label IOzoneID ( ) const

inline

ID of the cellZone holding the IOcells.

Definition at line 209 of file topOZones.H.

References IOcellsID_.

◆ getBetaMax()

scalar getBetaMax ( ) const

inline

Get betaMax.

Definition at line 217 of file topOZones.H.

References betaMaxPtr_.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Mesh reference.

Definition at line 59 of file topOZones.H.

Referenced by addIOcellsZone(), getZoneIDs(), IOCells(), mesh(), and topOZones().

◆ dict_

const dictionary dict_

protected

TopO design variables dictionary.

Definition at line 64 of file topOZones.H.

Referenced by topOZones().

◆ fixedPorousIDs_

labelList fixedPorousIDs_

protected

IDs of cellZones holding cells with constant alpha values.

Definition at line 69 of file topOZones.H.

Referenced by fixedPorousZoneIDs(), and topOZones().

◆ fixedPorousValues_

scalarList fixedPorousValues_

protected

The constant alpha values of fixedPorousIDs_.

Definition at line 74 of file topOZones.H.

Referenced by fixedPorousValues(), and topOZones().

◆ fixedZeroPorousIDs_

labelList fixedZeroPorousIDs_

protected

IDs of cellZones holding cells with zero alpha values.

Definition at line 79 of file topOZones.H.

Referenced by fixedZeroPorousZoneIDs(), and topOZones().

◆ adjointPorousIDs_

labelList adjointPorousIDs_

protected

IDs of cellZones with cells that can change their alpha value throughout the optimisation.

Definition at line 85 of file topOZones.H.

Referenced by adjointPorousZoneIDs(), and topOZones().

◆ IOcellsID_

label IOcellsID_

protected

ID of the cellZone holding the cells next to inlets & outlets.

Definition at line 90 of file topOZones.H.

Referenced by addIOcellsZone(), IOCells(), IOzoneID(), and topOZones().

◆ betaMaxPtr_

autoPtr<betaMax> betaMaxPtr_

protected

The multiplier of the Brinkman penalisation term.

Definition at line 95 of file topOZones.H.

Referenced by getBetaMax(), and topOZones().

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

src/optimisation/adjointOptimisation/adjoint/optimisation/designVariables/topODesignVariables/topOZones/topOZones.H
src/optimisation/adjointOptimisation/adjoint/optimisation/designVariables/topODesignVariables/topOZones/topOZones.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ topOZones()

◆ ~topOZones()

Member Function Documentation

◆ getZoneIDs()

◆ addIOcellsZone()

◆ TypeName()

◆ mesh()

◆ fixedPorousZoneIDs()

◆ fixedPorousValues()

◆ fixedZeroPorousZoneIDs()

◆ adjointPorousZoneIDs()

◆ IOCells()

◆ IOzoneID()

◆ getBetaMax()

Member Data Documentation

◆ mesh_

◆ dict_

◆ fixedPorousIDs_

◆ fixedPorousValues_

◆ fixedZeroPorousIDs_

◆ adjointPorousIDs_

◆ IOcellsID_

◆ betaMaxPtr_