Similar to fv::option but with additional functionality to contribute to the sensitivity deriavtives. More...

Inheritance diagram for optionAdjoint:

Collaboration diagram for optionAdjoint:

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

	optionAdjoint (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...

autoPtr< optionAdjoint >	clone () const
	Return clone. More...

	declareRunTimeSelectionTable (autoPtr, optionAdjoint, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))

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

virtual tmp< volVectorField >	dxdbMult (const incompressibleAdjointVars &)

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

	declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))

	option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...

autoPtr< option >	clone () const
	Return clone. More...

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

const word &	name () const
	Return const access to the source name. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs () const
	Return dictionary. More...

bool	active () const
	Return const access to the source active flag. More...

void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi. More...

Switch &	active ()
	Return access to the source active flag. More...

virtual bool	isActive ()
	Is the source active? More...

virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list. More...

virtual void	checkApplied () const
	Check that the source has been applied. More...

virtual void	addSup (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< vector > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	correct (volScalarField &field)

virtual void	correct (volVectorField &field)

virtual void	correct (volSphericalTensorField &field)

virtual void	correct (volSymmTensorField &field)

virtual void	correct (volTensorField &field)

virtual void	writeHeader (Ostream &) const
	Write the source header information. More...

virtual void	writeFooter (Ostream &) const
	Write the source footer information. More...

virtual void	writeData (Ostream &) const
	Write the source properties. More...

virtual bool	read (const dictionary &dict)
	Read source dictionary. More...

Static Public Member Functions
static autoPtr< optionAdjoint >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvOption model. More...

Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvOption model. More...

Additional Inherited Members
Public Attributes inherited from option
bool	log
	Switch write log to Info. More...

Protected Attributes inherited from option
const word	name_
	Source name. More...

const word	modelType_
	Model type. More...

const fvMesh &	mesh_
	Reference to the mesh database. More...

dictionary	dict_
	Top level source dictionary. More...

dictionary	coeffs_
	Dictionary containing source coefficients. More...

Switch	active_
	Source active flag. More...

wordList	fieldNames_
	Field names to apply source to - populated by derived models. More...

List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry. More...

Detailed Description

Similar to fv::option but with additional functionality to contribute to the sensitivity deriavtives.

Source files

Definition at line 58 of file fvOptionAdjoint.H.

Constructor & Destructor Documentation

◆ optionAdjoint()

optionAdjoint	(	const word &	name,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh
	)

Construct from components.

Definition at line 47 of file fvOptionAdjoint.C.

◆ ~optionAdjoint()

virtual ~optionAdjoint ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "optionAdjoint" )

Runtime type information.

◆ clone()

autoPtr<optionAdjoint> clone ( ) const

inline

Return clone.

Definition at line 80 of file fvOptionAdjoint.H.

References NotImplemented.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		optionAdjoint	,
		dictionary	,
		(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)	,
		(name, modelType, dict, mesh)
	)

◆ New()

Foam::autoPtr< Foam::fv::optionAdjoint > New	(	const word &	name,
		const dictionary &	dict,
		const fvMesh &	mesh
	)

static

Return a reference to the selected fvOption model.

Definition at line 61 of file fvOptionAdjoint.C.

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

Referenced by optionAdjointList::reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dxdbMult()

Foam::tmp< Foam::volVectorField > dxdbMult ( const incompressibleAdjointVars & )

virtual

Definition at line 92 of file fvOptionAdjoint.C.

References Foam::dimLength, Foam::dimTime, Foam::pow3(), and Foam::Zero.