Abstract base class for incompressible adjoint turbulence models (RAS, LES and laminar). More...

Inheritance diagram for adjointTurbulenceModel:

Collaboration diagram for adjointTurbulenceModel:

[legend]

Public Member Functions
	TypeName ("adjointTurbulenceModel")

	declareRunTimeNewSelectionTable (autoPtr, adjointTurbulenceModel, adjointTurbulenceModel,(incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName),(primalVars, adjointVars, objManager, adjointTurbulenceModelName))

	adjointTurbulenceModel (incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName=typeName)

virtual	~adjointTurbulenceModel ()=default

tmp< volScalarField >	nu () const

virtual const volScalarField &	nut () const

virtual tmp< volScalarField >	nuEff () const

virtual tmp< volSymmTensorField >	devReff () const =0

virtual tmp< volSymmTensorField >	devReff (const volVectorField &U) const =0

virtual tmp< fvVectorMatrix >	divDevReff (volVectorField &U) const =0

virtual tmp< volVectorField >	adjointMeanFlowSource ()=0

virtual void	correct ()=0

virtual bool	read ()=0

virtual bool	writeData (Ostream &) const

virtual void	nullify ()=0

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)

virtual	~regIOobject ()

bool	checkIn ()

bool	checkOut ()

virtual void	addWatch ()

bool	ownedByRegistry () const

bool	store ()

void	release (const bool unregister=false)

label	eventNo () const

label &	eventNo ()

bool	upToDate (const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const

void	setUpToDate ()

virtual void	rename (const word &newName)

const dictionary *	findMetaData () const noexcept

dictionary &	getMetaData () noexcept

void	removeMetaData ()

virtual void	updateMetaData ()

virtual fileName	filePath () const

bool	headerOk ()

Istream &	readStream (const word &, const bool valid=true)

void	close ()

virtual bool	readData (Istream &)

virtual label	addWatch (const fileName &)

const labelList &	watchIndices () const

labelList &	watchIndices ()

virtual bool	modified () const

virtual bool	readIfModified ()

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const

virtual bool	write (const bool valid=true) const

virtual bool	global () const

void	operator= (const IOobject &io)

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const

Public Member Functions inherited from IOobject
	TypeName ("IOobject")

	IOobject (const IOobject &)=default

virtual	~IOobject ()=default

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const IOobject &io, const objectRegistry &registry)

	IOobject (const IOobject &io, const word &name)

	IOobject (const IOobject &io, readOption, writeOption)

autoPtr< IOobject >	clone () const

autoPtr< IOobject >	clone (const objectRegistry &registry) const

const objectRegistry &	db () const noexcept

const Time &	time () const

const word &	name () const noexcept

const word &	headerClassName () const noexcept

word &	headerClassName () noexcept

const string &	note () const noexcept

string &	note () noexcept

bool	registerObject () const noexcept

bool	registerObject (bool on) noexcept

bool	globalObject () const noexcept

bool	globalObject (bool on) noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

bool	isHeaderClassName (const word &clsName) const

template<class Type >
bool	isHeaderClassName () const

readOption	readOpt () const noexcept

readOption	readOpt (readOption opt) noexcept

writeOption	writeOpt () const noexcept

writeOption	writeOpt (writeOption opt) noexcept

word	group () const

word	member () const

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const

fileName	path (const word &instance, const fileName &local=fileName::null) const

fileName	objectPath () const

fileName	objectRelPath () const

fileName	localFilePath (const word &typeName, const bool search=true) const

fileName	globalFilePath (const word &typeName, const bool search=true) const

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)

template<class Type >
void	warnNoRereading () const

bool	writeHeader (Ostream &os) const

bool	writeHeader (Ostream &os, const word &objectType) const

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept

writeOption &	writeOpt () noexcept

bool &	registerObject () noexcept

bool &	globalObject () noexcept

template<>
bool	isHeaderClassName () const

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Static Public Member Functions
static autoPtr< adjointTurbulenceModel >	New (incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName=typeName)

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)

template<class Type >
static Type &	store (autoPtr< Type > &ptr)

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)

template<class Type >
static Type &	store (refPtr< Type > &ptr)

template<class Type >
static Type &	store (refPtr< Type > &&ptr)

template<class Type >
static Type &	store (tmp< Type > &ptr)

template<class Type >
static Type &	store (tmp< Type > &&ptr)

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept

static bool	bannerEnabled (bool on) noexcept

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)

template<class StringType >
static word	groupName (StringType base, const word &group)

static word	group (const word &name)

static word	member (const word &name)

static word	scopedName (const std::string &scope, const word &name)

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)

static Ostream &	writeDivider (Ostream &os)

static Ostream &	writeEndDivider (Ostream &os)

Protected Attributes
incompressibleVars &	primalVars_

incompressibleAdjointMeanFlowVars &	adjointVars_

const Time &	runTime_

const fvMesh &	mesh_

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames

static char	scopeSeparator

static fileCheckTypes	fileModificationChecking

static float	fileModificationSkew

static int	maxFileModificationPolls

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)

Protected Member Functions inherited from IOobject
void	setBad (const string &s)

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false

Detailed Description

Abstract base class for incompressible adjoint turbulence models (RAS, LES and laminar).

Source files

Definition at line 68 of file adjointTurbulenceModel.H.

Constructor & Destructor Documentation

◆ adjointTurbulenceModel()

adjointTurbulenceModel	(	incompressibleVars &	primalVars,
		incompressibleAdjointMeanFlowVars &	adjointVars,
		objectiveManager &	objManager,
		const word &	adjointTurbulenceModelName = `typeName`
	)

Definition at line 42 of file adjointTurbulenceModel.C.

◆ ~adjointTurbulenceModel()

virtual ~adjointTurbulenceModel ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "adjointTurbulenceModel" )

◆ declareRunTimeNewSelectionTable()

declareRunTimeNewSelectionTable	(	autoPtr	,
		adjointTurbulenceModel	,
		adjointTurbulenceModel	,
		(incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName)	,
		(primalVars, adjointVars, objManager, adjointTurbulenceModelName)
	)

◆ New()

autoPtr< adjointTurbulenceModel > New	(	incompressibleVars &	primalVars,
		incompressibleAdjointMeanFlowVars &	adjointVars,
		objectiveManager &	objManager,
		const word &	adjointTurbulenceModelName = `typeName`
	)

static

Definition at line 70 of file adjointTurbulenceModel.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, dictionary::get(), Foam::Info, IOobject::MUST_READ_IF_MODIFIED, IOobject::NO_WRITE, and incompressibleVars::U().

Here is the call graph for this function:

◆ nu()

tmp<volScalarField> nu ( ) const

inline

Definition at line 152 of file adjointTurbulenceModel.H.

References incompressibleVars::laminarTransport(), singlePhaseTransportModel::nu(), and adjointTurbulenceModel::primalVars_.

Referenced by adjointSpalartAllmaras::chi(), adjointSpalartAllmaras::diffusionCoeffVar1(), adjointSpalartAllmaras::distanceSensitivities(), and adjointSpalartAllmaras::DnuTildaEff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nut()

virtual const volScalarField& nut ( ) const

inlinevirtual

Reimplemented in adjointSpalartAllmaras.

Definition at line 158 of file adjointTurbulenceModel.H.

References adjointTurbulenceModel::primalVars_, and incompressibleVars::RASModelVariables().

Referenced by adjointRASModel::nutJacobianTMVar1(), and adjointRASModel::nutJacobianTMVar2().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nuEff()

virtual tmp<volScalarField> nuEff ( ) const

inlinevirtual

Definition at line 164 of file adjointTurbulenceModel.H.

References incompressibleVars::laminarTransport(), tmp::New(), singlePhaseTransportModel::nu(), adjointTurbulenceModel::primalVars_, and incompressibleVars::RASModelVariables().

Referenced by adjointSpalartAllmaras::distanceSensitivities(), adjointLaminar::divDevReff(), and adjointSpalartAllmaras::divDevReff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ devReff() [1/2]

virtual tmp<volSymmTensorField> devReff ( ) const

pure virtual

Implemented in adjointRASModel, adjointSpalartAllmaras, and adjointLaminar.

◆ devReff() [2/2]

virtual tmp<volSymmTensorField> devReff ( const volVectorField & U ) const

pure virtual

Implemented in adjointRASModel, adjointSpalartAllmaras, and adjointLaminar.

◆ divDevReff()

virtual tmp<fvVectorMatrix> divDevReff ( volVectorField & U ) const

pure virtual

Implemented in adjointRASModel, adjointSpalartAllmaras, and adjointLaminar.

◆ adjointMeanFlowSource()

virtual tmp<volVectorField> adjointMeanFlowSource ( )

pure virtual

Implemented in adjointRASModel, adjointSpalartAllmaras, and adjointLaminar.

◆ correct()

void correct ( )

pure virtual

Implemented in adjointSpalartAllmaras, adjointRASModel, and adjointLaminar.

Definition at line 122 of file adjointTurbulenceModel.C.

References singlePhaseTransportModel::correct(), incompressibleVars::laminarTransport(), and adjointTurbulenceModel::primalVars_.

Referenced by adjointLaminar::correct(), adjointRASModel::correct(), and adjointSpalartAllmaras::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

virtual bool read ( )

pure virtual

Reimplemented from regIOobject.

Implemented in adjointSpalartAllmaras, adjointRASModel, and adjointLaminar.

◆ writeData()

virtual bool writeData ( Ostream & ) const

inlinevirtual

Implements regIOobject.

Definition at line 205 of file adjointTurbulenceModel.H.

◆ nullify()

virtual void nullify ( )

pure virtual

Implemented in adjointRASModel, adjointSpalartAllmaras, and adjointLaminar.

Member Data Documentation

◆ primalVars_

incompressibleVars& primalVars_

protected

Definition at line 87 of file adjointTurbulenceModel.H.

Referenced by adjointTurbulenceModel::correct(), adjointSpalartAllmaras::correct(), adjointSpalartAllmaras::distanceSensitivities(), adjointSpalartAllmaras::FISensitivityTerm(), adjointTurbulenceModel::nu(), adjointTurbulenceModel::nuEff(), adjointTurbulenceModel::nut(), adjointSpalartAllmaras::nut(), adjointSpalartAllmaras::nuTilda(), adjointRASModel::primalSolverName(), and adjointSpalartAllmaras::updatePrimalRelatedFields().

◆ adjointVars_

incompressibleAdjointMeanFlowVars& adjointVars_

protected

Definition at line 88 of file adjointTurbulenceModel.H.

Referenced by adjointRASModel::adjointSolverName(), adjointRASModel::computeMeanFields(), adjointSpalartAllmaras::correct(), adjointLaminar::devReff(), adjointSpalartAllmaras::devReff(), adjointSpalartAllmaras::distanceSensitivities(), adjointRASModel::getAdjointTMVariable1(), adjointRASModel::getAdjointTMVariable2(), adjointRASModel::resetMeanFields(), and adjointRASModel::setMeanFields().

◆ runTime_

const Time& runTime_

protected

Definition at line 89 of file adjointTurbulenceModel.H.

Referenced by adjointLaminar::adjointMeanFlowSource(), adjointLaminar::distanceSensitivities(), and adjointLaminar::FISensitivityTerm().

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 90 of file adjointTurbulenceModel.H.

Referenced by adjointLaminar::adjointMeanFlowSource(), adjointSpalartAllmaras::allocateMask(), adjointSpalartAllmaras::conservativeMomentumSource(), adjointRASModel::correct(), adjointRASModel::diffusionCoeffVar1(), adjointSpalartAllmaras::diffusionCoeffVar1(), adjointRASModel::diffusionCoeffVar2(), adjointLaminar::distanceSensitivities(), adjointSpalartAllmaras::distanceSensitivities(), adjointLaminar::FISensitivityTerm(), adjointSpalartAllmaras::FISensitivityTerm(), adjointRASModel::getAdjointTMVariable1Inst(), adjointRASModel::getAdjointTMVariable2Inst(), adjointRASModel::nutJacobianTMVar1(), adjointRASModel::nutJacobianTMVar2(), adjointRASModel::setMeanFields(), adjointSpalartAllmaras::wallFloCoSensitivities(), and adjointSpalartAllmaras::wallShapeSensitivities().

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

src/optimisation/adjointOptimisation/adjoint/turbulenceModels/incompressibleAdjoint/adjointTurbulenceModel/adjointTurbulenceModel.H
src/optimisation/adjointOptimisation/adjoint/turbulenceModels/incompressibleAdjoint/adjointTurbulenceModel/adjointTurbulenceModel.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ adjointTurbulenceModel()

◆ ~adjointTurbulenceModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeNewSelectionTable()

◆ New()

◆ nu()

◆ nut()

◆ nuEff()

◆ devReff() [1/2]

◆ devReff() [2/2]

◆ divDevReff()

◆ adjointMeanFlowSource()

◆ correct()

◆ read()

◆ writeData()

◆ nullify()

Member Data Documentation

◆ primalVars_

◆ adjointVars_

◆ runTime_

◆ mesh_