Abstract base class for incompressible turbulence models. More...

Inheritance diagram for adjointRASModel:

Collaboration diagram for adjointRASModel:

Public Member Functions
	TypeName ("adjointRASModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, adjointRASModel, dictionary,(incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName),(primalVars, adjointVars, objManager, adjointTurbulenceModelName))

	adjointRASModel (const word &type, incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName=adjointTurbulenceModel::typeName)
	Construct from components. More...

virtual	~adjointRASModel ()=default
	Destructor. More...

const nearWallDist &	y () const
	Return the near wall distances. More...

const dictionary &	coeffDict () const
	Const access to the coefficients dictionary. More...

const word &	primalSolverName () const
	Const access to the primal solver name. More...

const word &	adjointSolverName () const
	Const access to the adjoint solver name. More...

volScalarField &	getAdjointTMVariable1Inst ()
	Return non-constant reference to adjoint turbulence model variable 1. More...

volScalarField &	getAdjointTMVariable2Inst ()
	Return non-constant reference to adjoint turbulence model variable 2. More...

volScalarField &	getAdjointTMVariable1 ()
	Return non-constant reference to adjoint turbulence model variable 1. More...

volScalarField &	getAdjointTMVariable2 ()
	Return non-constant reference to adjoint turbulence model variable 2. More...

autoPtr< volScalarField > &	getAdjointTMVariable1InstPtr ()
	Return non-constant autoPtr to adjoint turbulence model variable 1. More...

autoPtr< volScalarField > &	getAdjointTMVariable2InstPtr ()
	Return non-constant autoPtr to adjoint turbulence model variable 2. More...

virtual tmp< volSymmTensorField >	devReff () const =0
	Return the effective stress tensor including the laminar stress. More...

virtual tmp< volSymmTensorField >	devReff (const volVectorField &U) const =0
	Return the effective stress tensor based on a given velocity field. More...

virtual tmp< fvVectorMatrix >	divDevReff (volVectorField &U) const =0
	Return the diffusion term for the momentum equation. More...

virtual tmp< volVectorField >	adjointMeanFlowSource ()=0

virtual tmp< volScalarField >	nutJacobianTMVar1 () const
	Jacobian of nut wrt the first turbulence model variable. More...

virtual tmp< volScalarField >	nutJacobianTMVar2 () const
	Jacobian of nut wrt the second turbulence model variable. More...

virtual tmp< scalarField >	diffusionCoeffVar1 (label patchI) const

virtual tmp< scalarField >	diffusionCoeffVar2 (label patchI) const

virtual const boundaryVectorField &	adjointMomentumBCSource () const =0

virtual const boundaryVectorField &	wallShapeSensitivities ()=0
	Sensitivity terms for shape optimisation, emerging from. More...

virtual const boundaryVectorField &	wallFloCoSensitivities ()=0
	Sensitivity terms for flow control, emerging from the. More...

virtual tmp< volScalarField >	distanceSensitivities ()=0

virtual tmp< volTensorField >	FISensitivityTerm ()=0
	Term contributing to the computation of FI-based sensitivities. More...

virtual void	correct ()
	Solve the adjoint turbulence equations. More...

virtual bool	read ()
	Read adjointRASProperties dictionary. More...

void	setChangedPrimalSolution ()
	Set flag of changed primal solution to true. More...

void	resetMeanFields ()
	Reset mean fields to zero. More...

void	computeMeanFields ()
	Average adjoint fields on the fly. More...

bool	includeDistance () const
	Should the adjoint to the eikonal equation be computed. More...

virtual void	nullify ()=0
	Nullify all adjoint turbulence model fields and their old times. More...

Public Member Functions inherited from adjointTurbulenceModel
	TypeName ("adjointTurbulenceModel")
	Runtime type information. More...

	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)
	Construct from components. More...

virtual	~adjointTurbulenceModel ()=default
	Destructor. More...

tmp< volScalarField >	nu () const
	Return the laminar viscosity. More...

virtual const volScalarField &	nut () const
	Return the turbulence viscosity. More...

virtual tmp< volScalarField >	nuEff () const
	Return the effective viscosity. More...

virtual bool	writeData (Ostream &) const
	Default dummy write function. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

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

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

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

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

bool	store ()

void	release (const bool unregister=false)
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set as up-to-date. More...

virtual void	rename (const word &newName)
	Rename. More...

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool valid=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

virtual bool	write (const bool valid=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &io)
	Copy assignment. More...

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
	Write using given format, version and compression. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

virtual	~IOobject ()=default
	Destructor. More...

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

	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)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

	IOobject (const IOobject &io, readOption, writeOption)
	Copy construct, resetting io options. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

const objectRegistry &	db () const noexcept
	Return the local objectRegistry. More...

const Time &	time () const
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return name. More...

const word &	headerClassName () const noexcept
	Return name of the class name read from header. More...

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

const string &	note () const noexcept
	Return the optional note. More...

string &	note () noexcept
	Return non-constant access to the optional note. More...

bool	registerObject () const noexcept
	Should object created with this IOobject be registered? More...

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

bool	globalObject () const noexcept
	Is object same for all processors? More...

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const noexcept
	The read option. More...

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

writeOption	writeOpt () const noexcept
	The write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. More...

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const
	The complete path. More...

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

fileName	objectPath () const
	The complete path + object name. More...

fileName	objectRelPath () const
	The object path relative to the root. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

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)
	Read header (uses typeFilePath to find file) and check its info. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &os) const
	Write header with current type() More...

bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type. More...

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
	Return info proxy. More...

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

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

Public Member Functions inherited from IOdictionary
	IOdictionary (const IOobject &io, const dictionary *fallback=nullptr)

	IOdictionary (const IOobject &io, const dictionary &dict)

	IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)

	IOdictionary (const IOobject &io, Istream &is)
	Construct given an IOobject and Istream. More...

virtual	~IOdictionary ()=default
	Destructor. More...

virtual bool	global () const
	Is object global. More...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

Public Member Functions inherited from baseIOdictionary
	TypeName ("dictionary")
	Declare type-name, virtual type (with debug switch) More...

	baseIOdictionary (const baseIOdictionary &)=default
	Copy construct. More...

	baseIOdictionary (baseIOdictionary &&)=default
	Move construct. More...

virtual	~baseIOdictionary ()=default
	Destructor. More...

	baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)

	baseIOdictionary (const IOobject &io, const dictionary &dict)

	baseIOdictionary (const IOobject &io, Istream &is)
	Construct given an IOobject and Istream (ununsed) More...

const word &	name () const

virtual bool	readData (Istream &)
	The readData function required by regIOobject read operation. More...

virtual bool	writeData (Ostream &) const
	The writeData function required by regIOobject write operation. More...

void	operator= (const baseIOdictionary &rhs)
	Copy assignment of dictionary entries (leave regIOobject untouched) More...

void	operator= (const dictionary &rhs)
	Copy assignment of dictionary entries. More...

Public Member Functions inherited from dictionary
	ClassName ("dictionary")

	dictionary ()
	Default construct, a top-level empty dictionary. More...

	dictionary (const fileName &name)
	Construct top-level empty dictionary with given name. More...

	dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)

	dictionary (Istream &is)

	dictionary (Istream &is, bool keepHeader)

	dictionary (const dictionary &parentDict, const dictionary &dict)
	Copy construct given the parent dictionary. More...

	dictionary (const dictionary &dict)
	Copy construct top-level dictionary. More...

	dictionary (const dictionary *dict)
	Construct top-level dictionary as copy from pointer to dictionary. More...

	dictionary (const dictionary &parentDict, dictionary &&dict)
	Move construct for given parent dictionary. More...

	dictionary (dictionary &&dict)
	Move construct top-level dictionary. More...

autoPtr< dictionary >	clone () const
	Construct and return clone. More...

virtual	~dictionary ()
	Destructor. More...

const fileName &	name () const noexcept
	The dictionary name. More...

fileName &	name () noexcept
	The dictionary name for modification (use with caution). More...

word	dictName () const
	The local dictionary name (final part of scoped name) More...

fileName	relativeName (const bool caseTag=false) const
	The dictionary name relative to the case. More...

bool	isNullDict () const noexcept
	The dictionary is actually dictionary::null (root dictionary) More...

const dictionary &	parent () const noexcept
	Return the parent dictionary. More...

const dictionary &	topDict () const
	Return the top of the tree. More...

label	startLineNumber () const
	Return line number of first token in dictionary. More...

label	endLineNumber () const
	Return line number of last token in dictionary. More...

SHA1Digest	digest () const
	Return the SHA1 digest of the dictionary contents. More...

tokenList	tokens () const
	Return the dictionary as a list of tokens. More...

bool	found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for an entry (const access) with the given keyword. More...

entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find for an entry (non-const access) with the given keyword. More...

const entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry (const access) with the given keyword. More...

const entry *	findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for a scoped entry (const access) with the given keyword. More...

dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary pointer if present. More...

const dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary pointer if present. More...

const entry &	lookupEntry (const word &keyword, enum keyType::option matchOpt) const
	Search for an entry (const access) with the given keyword. More...

ITstream &	lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)

template<class T >
bool	readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)

template<class T , class Predicate >
bool	readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const

template<class T , class Predicate >
bool	readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

bool	isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Check if entry is found and is a sub-dictionary. More...

const dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary. More...

dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary &	subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary	subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const

const dictionary &	optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary, otherwise return this dictionary. More...

wordList	toc () const
	Return the table of contents. More...

wordList	sortedToc () const
	Return the sorted table of contents. More...

template<class Compare >
wordList	sortedToc (const Compare &comp) const
	Return table of contents sorted using the specified comparator. More...

List< keyType >	keys (bool patterns=false) const
	Return the list of available keys or patterns. More...

bool	substituteKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given keyword (which is prefixed by '$') More...

bool	substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given scoped keyword (which is prefixed by '$') More...

entry *	add (entry *entryPtr, bool mergeEntry=false)
	Add a new entry. More...

entry *	add (const entry &e, bool mergeEntry=false)
	Add an entry. More...

entry *	add (const keyType &k, const word &v, bool overwrite=false)
	Add a word entry. More...

entry *	add (const keyType &k, const string &v, bool overwrite=false)
	Add a string entry. More...

entry *	add (const keyType &k, const label v, bool overwrite=false)
	Add a label entry. More...

entry *	add (const keyType &k, const scalar v, bool overwrite=false)
	Add a scalar entry. More...

entry *	add (const keyType &k, const dictionary &d, bool mergeEntry=false)
	Add a dictionary entry. More...

template<class T >
entry *	add (const keyType &k, const T &v, bool overwrite=false)
	Add a T entry. More...

entry *	set (entry *entryPtr)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const entry &e)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const keyType &k, const dictionary &v)
	Assign a dictionary entry, overwriting any existing entry. More...

template<class T >
entry *	set (const keyType &k, const T &v)
	Assign a T entry, overwriting any existing entry. More...

bool	remove (const word &keyword)
	Remove an entry specified by keyword. More...

bool	changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
	Change the keyword for an entry,. More...

bool	merge (const dictionary &dict)
	Merge entries from the given dictionary. More...

void	clear ()
	Clear the dictionary. More...

void	transfer (dictionary &dict)
	Transfer the contents of the argument and annul the argument. More...

void	checkITstream (const ITstream &is, const word &keyword) const

bool	read (Istream &is)
	Read dictionary from Istream. Discards the header. More...

bool	read (Istream &is, bool keepHeader)
	Read dictionary from Istream, optionally keeping the header. More...

void	writeEntry (Ostream &os) const
	Write sub-dictionary with its dictName as its header. More...

void	writeEntry (const keyType &keyword, Ostream &os) const
	Write sub-dictionary with the keyword as its header. More...

void	writeEntries (Ostream &os, const bool extraNewLine=false) const
	Write dictionary entries. More...

void	write (Ostream &os, const bool subDict=true) const
	Write dictionary, normally with sub-dictionary formatting. More...

const_searcher	csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword. More...

const_searcher	search (const word &keyword, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword. More...

searcher	search (const word &keyword, enum keyType::option=keyType::REGEX)
	Search dictionary for given keyword. More...

const_searcher	csearchScoped (const word &keyword, enum keyType::option) const
	Search using scoping. More...

const_searcher	searchScoped (const word &keyword, enum keyType::option) const
	Search using dot or slash scoping. More...

searcher	searchScoped (const word &keyword, enum keyType::option)
	Search using dot or slash scoping. More...

const dictionary *	cfindScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

const dictionary *	findScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	findScopedDict (const fileName &dictPath)
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	makeScopedDict (const fileName &dictPath)
	Locate existing or create sub-dictionary using slash-scoping. More...

const_searcher	csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...

bool	foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...

const entry *	findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

const entry &	lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

ITstream &	lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const

template<class T >
bool	readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const

void	operator= (const dictionary &rhs)
	Copy assignment. More...

void	operator+= (const dictionary &rhs)
	Include entries from the given dictionary. More...

void	operator\|= (const dictionary &rhs)
	Conditionally include entries from the given dictionary. More...

void	operator<<= (const dictionary &rhs)
	Unconditionally include entries from the given dictionary. More...

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)

template<class T >
T	lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

ITstream &	operator[] (const word &keyword) const
	Deprecated(2018-07) find and return an entry data stream. More...

bool	found (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
	Deprecated(2018-10) More...

const entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const entry *	lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const dictionary *	subDictPtr (const word &keyword) const
	Deprecated(2018-10) More...

dictionary *	subDictPtr (const word &keyword)

const entry &	lookupEntry (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

ITstream &	lookup (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
	Deprecated(2018-10) More...

template<class T >
bool	readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
	Deprecated(2018-10) find and return a T. More...

bool	getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< bool >(const word&, keyType::option) More...

label	getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< label >(const word&, keyType::option) More...

scalar	getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< scalar >(const word&, keyType::option) More...

string	getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< string >(const word&, keyType::option) More...

word	getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< word >(const word&, keyType::option) More...

fileName	getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< fileName >(const word&, keyType::option) More...

template<class Compare >
Foam::wordList	sortedToc (const Compare &comp) const

template<class T >
Foam::entry *	add (const keyType &k, const T &v, bool overwrite)

template<class T >
Foam::entry *	set (const keyType &k, const T &v)

Public Member Functions inherited from ILList< LListBase, T >
	ILList ()=default
	Default construct. More...

	ILList (T *item)
	Construct and insert the initial T item pointer. More...

	ILList (Istream &is)
	Construct from Istream. More...

	ILList (const ILList< LListBase, T > &lst)
	Copy construct using the 'clone()' method for each element. More...

	ILList (ILList< LListBase, T > &&lst)
	Move construct. More...

template<class CloneArg >
	ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone 'clone()'. More...

template<class INew >
	ILList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...

	~ILList ()
	Destructor. More...

bool	eraseHead ()
	Remove the head element specified from the list and delete it. More...

bool	erase (T *item)
	Remove the specified element from the list and delete it. More...

void	clear ()
	Clear the contents of the list. More...

void	transfer (ILList< LListBase, T > &lst)

void	operator= (const ILList< LListBase, T > &lst)
	Copy assignment using the 'clone()' method for each element. More...

void	operator= (ILList< LListBase, T > &&lst)
	Move assignment. More...

Static Public Member Functions
static autoPtr< adjointRASModel >	New (incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName=adjointTurbulenceModel::typeName)
	Return a reference to the selected adjointRAS model. More...

Static Public Member Functions inherited from adjointTurbulenceModel
static autoPtr< adjointTurbulenceModel >	New (incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName=typeName)
	Return a reference to the selected turbulence model. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable an output file banner. More...

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from dictionary
static int	reportOptional () noexcept
	Return the state of reporting optional (default) entries. More...

static int	reportOptional (const int level) noexcept
	Change the state of reporting optional (default) entries. More...

static autoPtr< dictionary >	New (Istream &is)
	Construct top-level dictionary on freestore from Istream. More...

Protected Member Functions
virtual void	printCoeffs ()
	Print model coefficients. More...

void	setMeanFields ()
	Set mean fields. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...

Protected Attributes
objectiveManager &	objectiveManager_
	Reference to the objectiveManager. More...

Switch	adjointTurbulence_
	Turbulence on/off flag. More...

Switch	printCoeffs_
	Flag to print the model coeffs at run-time. More...

dictionary	coeffDict_
	Model coefficients dictionary. More...

nearWallDist	y_
	Near wall distance boundary field. More...

autoPtr< volScalarField >	adjointTMVariable1Ptr_
	Adjoint turbulence model variable 1. More...

autoPtr< volScalarField >	adjointTMVariable2Ptr_
	Adjoint turbulence model variable 2. More...

autoPtr< volScalarField >	adjointTMVariable1MeanPtr_
	Adjoint turbulence model variable 1, mean value. More...

autoPtr< volScalarField >	adjointTMVariable2MeanPtr_
	Adjoint turbulence model variable 2, mean value. More...

autoPtr< boundaryVectorField >	adjMomentumBCSourcePtr_

autoPtr< boundaryVectorField >	wallShapeSensitivitiesPtr_
	Wall sensitivity term for shape optimisation. More...

autoPtr< boundaryVectorField >	wallFloCoSensitivitiesPtr_
	Wall sensitivity term for flow control optimisation. More...

bool	includeDistance_

bool	changedPrimalSolution_
	Has the primal solution changed? More...

Protected Attributes inherited from adjointTurbulenceModel
incompressibleVars &	primalVars_

incompressibleAdjointMeanFlowVars &	adjointVars_

const Time &	runTime_

const fvMesh &	mesh_

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Public Types inherited from dictionary
typedef Searcher< true >	const_searcher
	Searcher with const access. More...

typedef Searcher< false >	searcher
	Searcher with non-const access. More...

Public Attributes inherited from dictionary
friend	const_searcher
	Declare friendship with the searcher classes. More...

friend	searcher

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

Static Public Attributes inherited from dictionary
static int	writeOptionalEntries
	Report optional keywords and values if not present in dictionary. More...

static const dictionary	null
	An empty dictionary, which is also the parent for all dictionaries. More...

static refPtr< OSstream >	reportingOutput
	Output location when reporting default values. More...

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
	To flag master-only reading of objects. More...

Detailed Description

Abstract base class for incompressible turbulence models.

Source files

Definition at line 77 of file adjointRASModel.H.

Constructor & Destructor Documentation

◆ adjointRASModel()

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

Construct from components.

Definition at line 113 of file adjointRASModel.C.

◆ ~adjointRASModel()

virtual ~adjointRASModel ( )

virtualdefault

Destructor.

Member Function Documentation

◆ printCoeffs()

void printCoeffs ( )

protectedvirtual

Print model coefficients.

Definition at line 55 of file adjointRASModel.C.

References adjointRASModel::coeffDict_, Foam::endl(), Foam::Info, adjointRASModel::printCoeffs_, and Foam::type().

Here is the call graph for this function:

◆ setMeanFields()

void setMeanFields ( )

protected

Set mean fields.

Definition at line 64 of file adjointRASModel.C.

References adjointRASModel::adjointTMVariable1MeanPtr_, adjointRASModel::adjointTMVariable1Ptr_, adjointRASModel::adjointTMVariable2MeanPtr_, adjointRASModel::adjointTMVariable2Ptr_, adjointTurbulenceModel::adjointVars_, IOobject::AUTO_WRITE, solverControl::average(), adjointRASModel::getAdjointTMVariable1Inst(), adjointRASModel::getAdjointTMVariable2Inst(), incompressibleAdjointMeanFlowVars::getSolverControl(), adjointTurbulenceModel::mesh_, baseIOdictionary::name(), IOobject::READ_IF_PRESENT, fvMesh::time(), and Time::timeName().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "adjointRASModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		adjointRASModel	,
		dictionary	,
		(incompressibleVars &primalVars, incompressibleAdjointMeanFlowVars &adjointVars, objectiveManager &objManager, const word &adjointTurbulenceModelName)	,
		(primalVars, adjointVars, objManager, adjointTurbulenceModelName)
	)

◆ New()

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

static

Return a reference to the selected adjointRAS model.

Definition at line 163 of file adjointRASModel.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, IOobject::MUST_READ_IF_MODIFIED, IOobject::NO_WRITE, and incompressibleVars::U().

Here is the call graph for this function:

◆ y()

const nearWallDist& y ( ) const

inline

Return the near wall distances.

Definition at line 213 of file adjointRASModel.H.

References adjointRASModel::y_.

Referenced by adjointSpalartAllmaras::distanceSensitivities().

Here is the caller graph for this function:

◆ coeffDict()

const dictionary& coeffDict ( ) const

inline

Const access to the coefficients dictionary.

Definition at line 219 of file adjointRASModel.H.

References adjointRASModel::coeffDict_.

Referenced by adjointSpalartAllmaras::read().

Here is the caller graph for this function:

◆ primalSolverName()

const word& primalSolverName ( ) const

inline

Const access to the primal solver name.

Definition at line 225 of file adjointRASModel.H.

References adjointTurbulenceModel::primalVars_, and variablesSet::solverName().

Here is the call graph for this function:

◆ adjointSolverName()

const word& adjointSolverName ( ) const

inline

Const access to the adjoint solver name.

Definition at line 231 of file adjointRASModel.H.

References adjointTurbulenceModel::adjointVars_, and variablesSet::solverName().

Here is the call graph for this function:

◆ getAdjointTMVariable1Inst()

volScalarField & getAdjointTMVariable1Inst ( )

Return non-constant reference to adjoint turbulence model variable 1.

Will allocate and return a zero field in case it does not exist

Definition at line 261 of file adjointRASModel.C.

References adjointRASModel::adjointTMVariable1Ptr_, Foam::dimless, adjointTurbulenceModel::mesh_, IOobject::NO_READ, IOobject::NO_WRITE, fvMesh::time(), Time::timeName(), Foam::type(), and Foam::Zero.

Referenced by adjointRASModel::computeMeanFields(), adjointRASModel::getAdjointTMVariable1(), and adjointRASModel::setMeanFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdjointTMVariable2Inst()

volScalarField & getAdjointTMVariable2Inst ( )

Return non-constant reference to adjoint turbulence model variable 2.

Will allocate and return a zero field in case it does not exist

Definition at line 288 of file adjointRASModel.C.

References adjointRASModel::adjointTMVariable2Ptr_, Foam::dimless, adjointTurbulenceModel::mesh_, IOobject::NO_READ, IOobject::NO_WRITE, fvMesh::time(), Time::timeName(), Foam::type(), and Foam::Zero.

Referenced by adjointRASModel::computeMeanFields(), adjointRASModel::getAdjointTMVariable2(), and adjointRASModel::setMeanFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdjointTMVariable1()

volScalarField & getAdjointTMVariable1 ( )

Return non-constant reference to adjoint turbulence model variable 1.

Will return the mean value if present, otherwise the instantaneous value

Definition at line 315 of file adjointRASModel.C.

References adjointRASModel::adjointTMVariable1MeanPtr_, adjointTurbulenceModel::adjointVars_, adjointRASModel::getAdjointTMVariable1Inst(), incompressibleAdjointMeanFlowVars::getSolverControl(), and solverControl::useAveragedFields().

Here is the call graph for this function:

◆ getAdjointTMVariable2()

volScalarField & getAdjointTMVariable2 ( )

Return non-constant reference to adjoint turbulence model variable 2.

Will return the mean value if present, otherwise the instantaneous value

Definition at line 329 of file adjointRASModel.C.

References adjointRASModel::adjointTMVariable2MeanPtr_, adjointTurbulenceModel::adjointVars_, adjointRASModel::getAdjointTMVariable2Inst(), incompressibleAdjointMeanFlowVars::getSolverControl(), and solverControl::useAveragedFields().

Here is the call graph for this function:

◆ getAdjointTMVariable1InstPtr()

autoPtr< volScalarField > & getAdjointTMVariable1InstPtr ( )

Return non-constant autoPtr to adjoint turbulence model variable 1.

Definition at line 342 of file adjointRASModel.C.

References adjointRASModel::adjointTMVariable1Ptr_.

◆ getAdjointTMVariable2InstPtr()

autoPtr< volScalarField > & getAdjointTMVariable2InstPtr ( )

Return non-constant autoPtr to adjoint turbulence model variable 2.

Definition at line 348 of file adjointRASModel.C.

References adjointRASModel::adjointTMVariable2Ptr_.

◆ devReff() [1/2]

virtual tmp<volSymmTensorField> devReff ( ) const

pure virtual

Return the effective stress tensor including the laminar stress.

Implements adjointTurbulenceModel.

Implemented in adjointSpalartAllmaras, and adjointLaminar.

◆ devReff() [2/2]

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

pure virtual

Return the effective stress tensor based on a given velocity field.

Implements adjointTurbulenceModel.

Implemented in adjointSpalartAllmaras, and adjointLaminar.

◆ divDevReff()

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

pure virtual

Return the diffusion term for the momentum equation.

Implements adjointTurbulenceModel.

Implemented in adjointSpalartAllmaras, and adjointLaminar.

Referenced by adjointSimple::mainIter().

Here is the caller graph for this function:

◆ adjointMeanFlowSource()

virtual tmp<volVectorField> adjointMeanFlowSource ( )

pure virtual

Source terms to the adjoint momentum equation due to the differentiation of the turbulence model

Implements adjointTurbulenceModel.

Implemented in adjointSpalartAllmaras, and adjointLaminar.

Referenced by adjointSimple::mainIter().

Here is the caller graph for this function:

◆ nutJacobianTMVar1()

tmp< volScalarField > nutJacobianTMVar1 ( ) const

virtual

Jacobian of nut wrt the first turbulence model variable.

Needed for objective functions that depend on nut. Defaults to zero

Reimplemented in adjointSpalartAllmaras.

Definition at line 354 of file adjointRASModel.C.

References adjointRASModel::adjointTMVariable1Ptr_, adjointTurbulenceModel::mesh_, tmp< T >::New(), IOobject::NO_READ, IOobject::NO_WRITE, adjointTurbulenceModel::nut(), fvMesh::time(), Time::timeName(), Foam::type(), and Foam::Zero.

Here is the call graph for this function:

◆ nutJacobianTMVar2()

tmp< volScalarField > nutJacobianTMVar2 ( ) const

virtual

Jacobian of nut wrt the second turbulence model variable.

Needed for objective functions that depend on nut. Defaults to zero

Definition at line 377 of file adjointRASModel.C.

References adjointRASModel::adjointTMVariable2Ptr_, adjointTurbulenceModel::mesh_, tmp< T >::New(), IOobject::NO_READ, IOobject::NO_WRITE, adjointTurbulenceModel::nut(), fvMesh::time(), Time::timeName(), Foam::type(), and Foam::Zero.

Here is the call graph for this function:

◆ diffusionCoeffVar1()

tmp< scalarField > diffusionCoeffVar1 ( label patchI ) const

virtual

Diffusion coefficient of the first primal and adjoint turbulence model equation. Needed for some adjoint BCs. Defaults to zero

Reimplemented in adjointSpalartAllmaras.

Definition at line 400 of file adjointRASModel.C.

References fvMesh::boundary(), adjointTurbulenceModel::mesh_, tmp< T >::New(), and Foam::Zero.

Here is the call graph for this function:

◆ diffusionCoeffVar2()

tmp< scalarField > diffusionCoeffVar2 ( label patchI ) const

virtual

Diffusion coefficient of the second primal and adjoint turbulence model equation. Needed for some adjoint BCs. Defaults to zero

Definition at line 406 of file adjointRASModel.C.

References fvMesh::boundary(), adjointTurbulenceModel::mesh_, tmp< T >::New(), and Foam::Zero.

Here is the call graph for this function:

◆ adjointMomentumBCSource()

virtual const boundaryVectorField& adjointMomentumBCSource ( ) const

pure virtual

Source for the outlet adjoint momentum BC coming from differentiating the turbulence model

Implemented in adjointSpalartAllmaras, and adjointLaminar.

◆ wallShapeSensitivities()

virtual const boundaryVectorField& wallShapeSensitivities ( )

pure virtual

Sensitivity terms for shape optimisation, emerging from.

the turbulence model differentiation. Misses dxdb, to be added by the classes assembling the sensitivities

Implemented in adjointSpalartAllmaras, and adjointLaminar.

◆ wallFloCoSensitivities()

virtual const boundaryVectorField& wallFloCoSensitivities ( )

pure virtual

Sensitivity terms for flow control, emerging from the.

turbulence model differentiation

Implemented in adjointSpalartAllmaras, and adjointLaminar.

◆ distanceSensitivities()

virtual tmp<volScalarField> distanceSensitivities ( )

pure virtual

Sensitivity terms resulting from the differentiation of the distance field. Misses dxdb, to be added by the classes assembling the sensitivities

Implemented in adjointSpalartAllmaras, and adjointLaminar.

Referenced by adjointEikonalSolver::accumulateIntegrand().

Here is the caller graph for this function:

◆ FISensitivityTerm()

virtual tmp<volTensorField> FISensitivityTerm ( )

pure virtual

Term contributing to the computation of FI-based sensitivities.

Misses grad(dxdb), to be added by the assembling the sensitivities

Implemented in adjointSpalartAllmaras, and adjointLaminar.

◆ correct()

void correct ( )

virtual

Solve the adjoint turbulence equations.

Implements adjointTurbulenceModel.

Reimplemented in adjointSpalartAllmaras, and adjointLaminar.

Definition at line 215 of file adjointRASModel.C.

References adjointRASModel::adjointTurbulence_, polyMesh::changing(), nearWallDist::correct(), adjointTurbulenceModel::correct(), adjointTurbulenceModel::mesh_, and adjointRASModel::y_.

Referenced by adjointSimple::mainIter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

bool read ( )

virtual

Read adjointRASProperties dictionary.

Implements adjointTurbulenceModel.

Reimplemented in adjointSpalartAllmaras, and adjointLaminar.

Definition at line 226 of file adjointRASModel.C.

References adjointRASModel::adjointTurbulence_, regIOobject::close(), adjointRASModel::coeffDict_, dictionary::findDict(), baseIOdictionary::readData(), dictionary::readEntry(), and Foam::type().

Referenced by adjointLaminar::read(), and adjointSpalartAllmaras::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setChangedPrimalSolution()

void setChangedPrimalSolution ( )

Set flag of changed primal solution to true.

Definition at line 412 of file adjointRASModel.C.

References adjointRASModel::changedPrimalSolution_.

◆ resetMeanFields()

void resetMeanFields ( )

Reset mean fields to zero.

Definition at line 418 of file adjointRASModel.C.

References adjointRASModel::adjointTMVariable1MeanPtr_, adjointRASModel::adjointTMVariable1Ptr_, adjointRASModel::adjointTMVariable2MeanPtr_, adjointRASModel::adjointTMVariable2Ptr_, adjointTurbulenceModel::adjointVars_, solverControl::average(), incompressibleAdjointMeanFlowVars::getSolverControl(), and Foam::Zero.

Here is the call graph for this function:

◆ computeMeanFields()

void computeMeanFields ( )

Average adjoint fields on the fly.

Definition at line 437 of file adjointRASModel.C.

References adjointRASModel::adjointTMVariable1MeanPtr_, adjointRASModel::adjointTMVariable1Ptr_, adjointRASModel::adjointTMVariable2MeanPtr_, adjointRASModel::adjointTMVariable2Ptr_, adjointTurbulenceModel::adjointVars_, solverControl::averageIter(), solverControl::doAverageIter(), adjointRASModel::getAdjointTMVariable1Inst(), adjointRASModel::getAdjointTMVariable2Inst(), and incompressibleAdjointMeanFlowVars::getSolverControl().

Here is the call graph for this function:

◆ includeDistance()

bool includeDistance ( ) const

Should the adjoint to the eikonal equation be computed.

Definition at line 462 of file adjointRASModel.C.

References adjointRASModel::includeDistance_.

◆ nullify()

virtual void nullify ( )

pure virtual

Nullify all adjoint turbulence model fields and their old times.

Implements adjointTurbulenceModel.

Implemented in adjointSpalartAllmaras, and adjointLaminar.

Member Data Documentation

◆ objectiveManager_

objectiveManager& objectiveManager_

protected

Reference to the objectiveManager.

Definition at line 98 of file adjointRASModel.H.

Referenced by adjointSpalartAllmaras::correct(), and adjointSpalartAllmaras::distanceSensitivities().

◆ adjointTurbulence_

Switch adjointTurbulence_

protected

Turbulence on/off flag.

Definition at line 101 of file adjointRASModel.H.

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

◆ printCoeffs_

Switch printCoeffs_

protected

Flag to print the model coeffs at run-time.

Definition at line 104 of file adjointRASModel.H.

Referenced by adjointRASModel::printCoeffs().

◆ coeffDict_

dictionary coeffDict_

protected

Model coefficients dictionary.

Definition at line 107 of file adjointRASModel.H.

Referenced by adjointSpalartAllmaras::allocateMask(), adjointRASModel::coeffDict(), adjointRASModel::printCoeffs(), and adjointRASModel::read().

◆ y_

nearWallDist y_

protected

Near wall distance boundary field.

Definition at line 110 of file adjointRASModel.H.

Referenced by adjointRASModel::correct(), and adjointRASModel::y().

◆ adjointTMVariable1Ptr_

autoPtr<volScalarField> adjointTMVariable1Ptr_

protected

Adjoint turbulence model variable 1.

Definition at line 113 of file adjointRASModel.H.

Referenced by adjointRASModel::computeMeanFields(), adjointRASModel::getAdjointTMVariable1Inst(), adjointRASModel::getAdjointTMVariable1InstPtr(), adjointSpalartAllmaras::nuaTilda(), adjointRASModel::nutJacobianTMVar1(), adjointRASModel::resetMeanFields(), and adjointRASModel::setMeanFields().

◆ adjointTMVariable2Ptr_

autoPtr<volScalarField> adjointTMVariable2Ptr_

protected

Adjoint turbulence model variable 2.

Definition at line 116 of file adjointRASModel.H.

Referenced by adjointRASModel::computeMeanFields(), adjointRASModel::getAdjointTMVariable2Inst(), adjointRASModel::getAdjointTMVariable2InstPtr(), adjointRASModel::nutJacobianTMVar2(), adjointRASModel::resetMeanFields(), and adjointRASModel::setMeanFields().

◆ adjointTMVariable1MeanPtr_

autoPtr<volScalarField> adjointTMVariable1MeanPtr_

protected

Adjoint turbulence model variable 1, mean value.

Definition at line 119 of file adjointRASModel.H.

Referenced by adjointRASModel::computeMeanFields(), adjointRASModel::getAdjointTMVariable1(), adjointRASModel::resetMeanFields(), and adjointRASModel::setMeanFields().

◆ adjointTMVariable2MeanPtr_

autoPtr<volScalarField> adjointTMVariable2MeanPtr_

protected

Adjoint turbulence model variable 2, mean value.

Definition at line 122 of file adjointRASModel.H.

Referenced by adjointRASModel::computeMeanFields(), adjointRASModel::getAdjointTMVariable2(), adjointRASModel::resetMeanFields(), and adjointRASModel::setMeanFields().

◆ adjMomentumBCSourcePtr_

autoPtr<boundaryVectorField> adjMomentumBCSourcePtr_

protected

Source to the adjoint momentum BC emerging from differentiating the turbulence model

Definition at line 126 of file adjointRASModel.H.

Referenced by adjointLaminar::adjointMomentumBCSource(), adjointSpalartAllmaras::adjointMomentumBCSource(), and adjointSpalartAllmaras::conservativeMomentumSource().

◆ wallShapeSensitivitiesPtr_

autoPtr<boundaryVectorField> wallShapeSensitivitiesPtr_

protected

Wall sensitivity term for shape optimisation.

Definition at line 129 of file adjointRASModel.H.

Referenced by adjointLaminar::wallShapeSensitivities(), and adjointSpalartAllmaras::wallShapeSensitivities().

◆ wallFloCoSensitivitiesPtr_

autoPtr<boundaryVectorField> wallFloCoSensitivitiesPtr_

protected

Wall sensitivity term for flow control optimisation.

Definition at line 132 of file adjointRASModel.H.

Referenced by adjointLaminar::wallFloCoSensitivities(), and adjointSpalartAllmaras::wallFloCoSensitivities().

◆ includeDistance_

bool includeDistance_

protected

Does the turbulence model include distances and should the adjoint to the distance field be computed

Definition at line 136 of file adjointRASModel.H.

Referenced by adjointRASModel::includeDistance().

◆ changedPrimalSolution_

bool changedPrimalSolution_

protected

Has the primal solution changed?

Definition at line 139 of file adjointRASModel.H.

Referenced by adjointRASModel::setChangedPrimalSolution(), and adjointSpalartAllmaras::updatePrimalRelatedFields().

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

src/optimisation/adjointOptimisation/adjoint/turbulenceModels/incompressibleAdjoint/adjointRAS/adjointRASModel/adjointRASModel.H
src/optimisation/adjointOptimisation/adjoint/turbulenceModels/incompressibleAdjoint/adjointRAS/adjointRASModel/adjointRASModel.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ adjointRASModel()

◆ ~adjointRASModel()

Member Function Documentation

◆ printCoeffs()

◆ setMeanFields()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ y()

◆ coeffDict()

◆ primalSolverName()

◆ adjointSolverName()

◆ getAdjointTMVariable1Inst()

◆ getAdjointTMVariable2Inst()

◆ getAdjointTMVariable1()

◆ getAdjointTMVariable2()

◆ getAdjointTMVariable1InstPtr()

◆ getAdjointTMVariable2InstPtr()

◆ devReff() [1/2]

◆ devReff() [2/2]

◆ divDevReff()

◆ adjointMeanFlowSource()

◆ nutJacobianTMVar1()

◆ nutJacobianTMVar2()

◆ diffusionCoeffVar1()

◆ diffusionCoeffVar2()

◆ adjointMomentumBCSource()

◆ wallShapeSensitivities()

◆ wallFloCoSensitivities()

◆ distanceSensitivities()

◆ FISensitivityTerm()

◆ correct()

◆ read()

◆ setChangedPrimalSolution()

◆ resetMeanFields()

◆ computeMeanFields()

◆ includeDistance()

◆ nullify()

Member Data Documentation

◆ objectiveManager_

◆ adjointTurbulence_

◆ printCoeffs_

◆ coeffDict_

◆ y_

◆ adjointTMVariable1Ptr_

◆ adjointTMVariable2Ptr_

◆ adjointTMVariable1MeanPtr_

◆ adjointTMVariable2MeanPtr_

◆ adjMomentumBCSourcePtr_

◆ wallShapeSensitivitiesPtr_

◆ wallFloCoSensitivitiesPtr_

◆ includeDistance_

◆ changedPrimalSolution_