Base class for selecting the adjoint transpose convection model. Inherits from regIOobject to add lookup functionality. More...

Inheritance diagram for ATCModel:

[legend]

Collaboration diagram for ATCModel:

[legend]

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

	declareRunTimeSelectionTable (autoPtr, ATCModel, dictionary,(const fvMesh &mesh, const incompressibleVars &primalVars, const incompressibleAdjointVars &adjointVars, const dictionary &dict),(mesh, primalVars, adjointVars, dict))

	ATCModel (const fvMesh &mesh, const incompressibleVars &primalVars, const incompressibleAdjointVars &adjointVars, const dictionary &dict)
	Construct from components. More...

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

virtual void	addATC (fvVectorMatrix &UaEqn)=0
	Add ATC to the given matrix. More...

const labelList &	getZeroATCcells ()
	Get the list of cells on which to zero ATC. More...

scalar	getExtraConvectionMultiplier ()
	Get the extra convection multiplier. More...

scalar	getExtraDiffusionMultiplier ()
	Get the extra diffusion multiplier. More...

const volScalarField &	getLimiter () const
	Get the list of cells on which to zero ATC. More...

template<class Type >
void	smoothFieldBasedOnCells (GeometricField< Type, fvPatchField, volMesh > &vf, const labelList &cells)
	Smooth an arbitrary field on a given list of cells. More...

virtual tmp< volTensorField >	getFISensitivityTerm () const =0
	Get the FI sensitivity derivatives term coming from the ATC. More...

virtual bool	writeData (Ostream &) const
	Dummy writeData function required from regIOobject. More...

virtual void	updatePrimalBasedQuantities ()
	Update quantities related with the primal fields. More...

Public Member Functions inherited from regIOobject
void	operator= (const regIOobject &)=delete
	No copy assignment. More...

	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &io, const bool isTimeObject=false)
	Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More...

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

	regIOobject (const regIOobject &rio, bool registerCopy)
	Copy construct, transferring registry registration to the copy if registerCopy is true. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More...

	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	registered () const noexcept
	Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More...

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

bool	store ()
	Register object with its registry and transfer ownership to the registry. More...

void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry. More...

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

label &	eventNo () noexcept
	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...

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

bool	headerOk ()
	Read and check header info. Does not check the headerClassName. More...

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

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

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

const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles. More...

labelList &	watchIndices () noexcept
	Write access to file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More...

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

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

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

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

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

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) 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, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from path, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::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, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::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, const word &name, const fileName &local)
	Copy construct, resetting name and local component. More...

	IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
	Copy construct, resetting read/write options. More...

	IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
	Copy construct, resetting register option. 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 noexcept
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return the object 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
	Modifiable access to the optional note. 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...

void	resetHeader (const word &newName=word::null)
	Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More...

bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading) More...

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

template<class Type >
bool	isHeaderClassName () const
	Same as isHeaderClass() 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 noexcept
	Return the Time::rootPath() More...

const fileName &	caseName () const noexcept
	Return the Time::caseName() More...

const fileName &	globalCaseName () const noexcept
	Return the Time::globalCaseName() More...

const fileName &	instance () const noexcept
	Read access to instance path component. More...

fileName &	instance () noexcept
	Write access to instance path component. More...

const fileName &	local () const noexcept
	Read access to local path component. More...

fileName	path () const
	The complete path for the object (with instance, local,...). More...

fileName	globalPath () const
	The complete global path for the object (with instance, local,...) More...

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

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

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

fileName	globalObjectPath () const
	The complete global 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
	Redirect to fileHandler filePath, searching locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching up if in parallel. More...

IOstreamOption	parseHeader (const dictionary &headerDict)
	Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More...

bool	readHeader (Istream &is)
	Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More...

bool	readHeader (dictionary &headerDict, Istream &is)
	Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More...

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (respects is_globalIOobject trait) and check its info. More...

template<class Type >
fileName	typeFilePath (const bool search=true) const
	Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. 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
	Write header into a dictionary with current type() and given output format. More...

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
	Write header into a dictionary with override of type and given output format. More...

bool	good () const noexcept
	Did last readHeader() succeed? More...

bool	bad () const noexcept
	Did last readHeader() fail? More...

InfoProxy< IOobject >	info () const noexcept
	Return info proxy, for printing information to a stream. More...

void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry) More...

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

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

template<class Type >
Foam::fileName	typeFilePath (const bool search) const

Public Member Functions inherited from IOobjectOption
constexpr	IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More...

constexpr	IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_WRITE with specified read/register options. More...

constexpr	IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_READ with specified write/register options. More...

constexpr	IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option. More...

constexpr	IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
	Construct from components with specified register option as bool. More...

constexpr	IOobjectOption (bool registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option as bool. More...

readOption	readOpt () const noexcept
	Get the read option. More...

readOption	readOpt (readOption opt) noexcept
	Set the read option. More...

writeOption	writeOpt () const noexcept
	Get the write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Set the write option. More...

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

bool	registerObject (bool on) noexcept
	Change registration preference. More...

bool	globalObject () const noexcept
	True if object is treated the same for all processors. More...

bool	globalObject (bool on) noexcept
	Change global-object status. More...

bool	isAnyRead () const noexcept
	True if any reading may be required (ie, != NO_READ) More...

bool	isReadRequired () const noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set. More...

bool	isReadOptional () const noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...

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...

Static Public Member Functions
static autoPtr< ATCModel >	New (const fvMesh &mesh, const incompressibleVars &primalVars, const incompressibleAdjointVars &adjointVars, const dictionary &dict)
	Return a reference to the selected turbulence model. More...

static void	computeLimiter (volScalarField &limiter, const labelList &smoothCells, const label nSmooth)
	Compute limiter based on the prescribed cells and number of smoothing iterations. More...

static tmp< volScalarField >	createLimiter (const fvMesh &mesh, const dictionary &dict)
	Return a limiter based on given cells. For use with classes other than ATC which employ the same smoothing mechanism. 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 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 word	scopedName (const std::string &scope, const word &name1, const word &name2)
	Create scope:name1:name2 or scope_name1_name2 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 IOobjectOption
static bool	isAnyRead (readOption opt) noexcept
	True if any reading may be required (ie, != NO_READ) More...

static bool	isReadRequired (readOption opt) noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set. More...

static bool	isReadOptional (readOption opt) noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...

static readOption	lazierRead (readOption opt) noexcept
	Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More...

Protected Member Functions
void	computeLimiter ()
	Compute limiter based on the cells given by zeroATCcells. More...

void	smoothATC ()
	Limit ATC field using ATClimiter_. 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
const fvMesh &	mesh_

const incompressibleVars &	primalVars_

const incompressibleAdjointVars &	adjointVars_

const dictionary &	dict_

const scalar	extraConvection_

const scalar	extraDiffusion_

const label	nSmooth_

const bool	reconstructGradients_

word	adjointSolverName_

autoPtr< zeroATCcells >	zeroATCcells_

volScalarField	ATClimiter_

volVectorField	ATC_

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

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

Public Types inherited from IOobjectOption
enum	readOption : unsigned char { NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3, LAZY_READ = 0x4, READ_IF_PRESENT = 0x4 }
	Enumeration defining read preferences. More...

enum	writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 }
	Enumeration defining write preferences. More...

enum	registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 }
	Enumeration for use with registerObject(). Values map to bool (false/true) More...

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 Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
	Helper: write content for FoamFile IOobject header with optional meta information. More...

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
	Helper: write dictionary content for FoamFile header with optional meta information. More...

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

Base class for selecting the adjoint transpose convection model. Inherits from regIOobject to add lookup functionality.

Source files

Definition at line 56 of file ATCModel.H.

Constructor & Destructor Documentation

◆ ATCModel()

ATCModel	(	const fvMesh &	mesh,
		const incompressibleVars &	primalVars,
		const incompressibleAdjointVars &	adjointVars,
		const dictionary &	dict
	)

Construct from components.

Definition at line 55 of file ATCModel.C.

◆ ~ATCModel()

virtual ~ATCModel ( )

virtualdefault

Destructor.

Member Function Documentation

◆ computeLimiter() [1/2]

void computeLimiter ( )

protected

Compute limiter based on the cells given by zeroATCcells.

Definition at line 38 of file ATCModel.C.

References ATCModel::ATClimiter_, ATCModel::nSmooth_, and ATCModel::zeroATCcells_.

◆ smoothATC()

void smoothATC ( )

protected

Limit ATC field using ATClimiter_.

Definition at line 44 of file ATCModel.C.

References ATCModel::ATC_, ATCModel::ATClimiter_, DebugInfo, Foam::endl(), and Foam::gMax().

Referenced by ATCUaGradU::addATC(), and ATCstandard::addATC().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "ATCModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		ATCModel	,
		dictionary	,
		(const fvMesh &mesh, const incompressibleVars &primalVars, const incompressibleAdjointVars &adjointVars, const dictionary &dict)	,
		(mesh, primalVars, adjointVars, dict)
	)

◆ New()

autoPtr< ATCModel > New	(	const fvMesh &	mesh,
		const incompressibleVars &	primalVars,
		const incompressibleAdjointVars &	adjointVars,
		const dictionary &	dict
	)

static

Return a reference to the selected turbulence model.

Definition at line 123 of file ATCModel.C.

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

Referenced by adjointSimple::adjointSimple().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addATC()

virtual void addATC ( fvVectorMatrix & UaEqn )

pure virtual

Add ATC to the given matrix.

Implemented in ATCstandard, cancelATC, and ATCUaGradU.

◆ getZeroATCcells()

const labelList & getZeroATCcells ( )

Get the list of cells on which to zero ATC.

Definition at line 156 of file ATCModel.C.

References ATCModel::zeroATCcells_.

◆ getExtraConvectionMultiplier()

scalar getExtraConvectionMultiplier ( )

Get the extra convection multiplier.

Definition at line 162 of file ATCModel.C.

References ATCModel::extraConvection_.

◆ getExtraDiffusionMultiplier()

scalar getExtraDiffusionMultiplier ( )

Get the extra diffusion multiplier.

Definition at line 168 of file ATCModel.C.

References ATCModel::extraDiffusion_.

◆ getLimiter()

const volScalarField & getLimiter ( ) const

Get the list of cells on which to zero ATC.

Definition at line 174 of file ATCModel.C.

References ATCModel::ATClimiter_.

Referenced by ATCstandard::getFISensitivityTerm().

Here is the caller graph for this function:

◆ computeLimiter() [2/2]

void computeLimiter	(	volScalarField &	limiter,
		const labelList &	smoothCells,
		const label	nSmooth
	)

static

Compute limiter based on the prescribed cells and number of smoothing iterations.

Definition at line 181 of file ATCModel.C.

References Foam::fvc::average(), cells, Foam::limiter(), mesh, Foam::fac::scheme(), and Foam::Zero.

Here is the call graph for this function:

◆ createLimiter()

tmp< volScalarField > createLimiter	(	const fvMesh &	mesh,
		const dictionary &	dict
	)

static

Return a limiter based on given cells. For use with classes other than ATC which employ the same smoothing mechanism.

Definition at line 216 of file ATCModel.C.

References dict, Foam::dimless, dictionary::getOrDefault(), zeroATCcells::getZeroATCcells(), Foam::limiter(), mesh, zeroATCcells::New(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, fvMesh::time(), Time::timeName(), zeroCells(), and fvPatchFieldBase::zeroGradientType().

Referenced by adjointSpalartAllmaras::allocateMask().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ smoothFieldBasedOnCells()

void smoothFieldBasedOnCells	(	GeometricField< Type, fvPatchField, volMesh > &	vf,
		const labelList &	cells
	)

Smooth an arbitrary field on a given list of cells.

Definition at line 30 of file ATCModelTemplates.C.

References cells, Foam::dimless, Foam::limiter(), IOobject::name(), and Foam::fieldTypes::zeroGradientType.

Here is the call graph for this function:

◆ getFISensitivityTerm()

virtual tmp<volTensorField> getFISensitivityTerm ( ) const

pure virtual

Get the FI sensitivity derivatives term coming from the ATC.

Implemented in ATCstandard, cancelATC, and ATCUaGradU.

◆ writeData()

bool writeData ( Ostream & ) const

virtual

Dummy writeData function required from regIOobject.

Implements regIOobject.

Definition at line 251 of file ATCModel.C.

◆ updatePrimalBasedQuantities()

void updatePrimalBasedQuantities ( )

virtual

Update quantities related with the primal fields.

Reimplemented in ATCstandard.

Definition at line 258 of file ATCModel.C.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 79 of file ATCModel.H.

Referenced by ATCUaGradU::getFISensitivityTerm(), cancelATC::getFISensitivityTerm(), and ATCstandard::getFISensitivityTerm().

◆ primalVars_

const incompressibleVars& primalVars_

protected

Definition at line 80 of file ATCModel.H.

Referenced by ATCUaGradU::addATC(), ATCstandard::addATC(), ATCUaGradU::getFISensitivityTerm(), ATCstandard::getFISensitivityTerm(), and ATCstandard::updatePrimalBasedQuantities().

◆ adjointVars_

const incompressibleAdjointVars& adjointVars_

protected

Definition at line 81 of file ATCModel.H.

Referenced by ATCUaGradU::addATC(), ATCstandard::addATC(), ATCUaGradU::getFISensitivityTerm(), and ATCstandard::getFISensitivityTerm().

◆ dict_

const dictionary& dict_

protected

Definition at line 84 of file ATCModel.H.

◆ extraConvection_

const scalar extraConvection_

protected

Definition at line 85 of file ATCModel.H.

Referenced by ATCUaGradU::addATC(), ATCstandard::addATC(), and ATCModel::getExtraConvectionMultiplier().

◆ extraDiffusion_

const scalar extraDiffusion_

protected

Definition at line 86 of file ATCModel.H.

Referenced by ATCModel::getExtraDiffusionMultiplier().

◆ nSmooth_

const label nSmooth_

protected

Definition at line 87 of file ATCModel.H.

Referenced by ATCModel::computeLimiter().

◆ reconstructGradients_

const bool reconstructGradients_

protected

Definition at line 88 of file ATCModel.H.

Referenced by ATCUaGradU::addATC(), and ATCstandard::updatePrimalBasedQuantities().

◆ adjointSolverName_

word adjointSolverName_

protected

Definition at line 89 of file ATCModel.H.

◆ zeroATCcells_

autoPtr<zeroATCcells> zeroATCcells_

protected

Definition at line 90 of file ATCModel.H.

Referenced by ATCModel::computeLimiter(), and ATCModel::getZeroATCcells().

◆ ATClimiter_

volScalarField ATClimiter_

protected

Definition at line 91 of file ATCModel.H.

Referenced by ATCUaGradU::addATC(), ATCstandard::addATC(), ATCModel::computeLimiter(), ATCModel::getLimiter(), and ATCModel::smoothATC().

◆ ATC_

volVectorField ATC_

protected

Definition at line 92 of file ATCModel.H.

Referenced by ATCUaGradU::addATC(), ATCstandard::addATC(), and ATCModel::smoothATC().

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

src/optimisation/adjointOptimisation/adjoint/ATCModel/ATCModel/ATCModel.H
src/optimisation/adjointOptimisation/adjoint/ATCModel/ATCModel/ATCModel.C
src/optimisation/adjointOptimisation/adjoint/ATCModel/ATCModel/ATCModelTemplates.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ATCModel()

◆ ~ATCModel()

Member Function Documentation

◆ computeLimiter() [1/2]

◆ smoothATC()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ addATC()

◆ getZeroATCcells()

◆ getExtraConvectionMultiplier()

◆ getExtraDiffusionMultiplier()

◆ getLimiter()

◆ computeLimiter() [2/2]

◆ createLimiter()

◆ smoothFieldBasedOnCells()

◆ getFISensitivityTerm()

◆ writeData()

◆ updatePrimalBasedQuantities()

Member Data Documentation

◆ mesh_

◆ primalVars_

◆ adjointVars_

◆ dict_

◆ extraConvection_

◆ extraDiffusion_

◆ nSmooth_

◆ reconstructGradients_

◆ adjointSolverName_

◆ zeroATCcells_

◆ ATClimiter_

◆ ATC_