DAInputField Class Reference

Inheritance diagram for DAInputField:

Collaboration diagram for DAInputField:

Public Member Functions
	TypeName ("field")
	DAInputField (const word inputName, const word inputType, fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)
virtual	~DAInputField ()
virtual void	run (const scalarList &input)
virtual label	size ()
virtual label	distributed ()
Public Member Functions inherited from DAInput
	TypeName ("DAInput")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, DAInput, dictionary,(const word inputName, const word inputType, fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex),(inputName, inputType, mesh, daOption, daModel, daIndex))
	DAInput (const word inputName, const word inputType, fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)
virtual	~DAInput ()

Protected Attributes
word	fieldName_
	name of the field More...
word	fieldType_
	field type, can be either scalar or vector More...
labelList	indices_
	if it is vector fields, we can also provide components/indices More...
Protected Attributes inherited from DAInput
const word	inputName_
	name of the input More...
const word	inputType_
	type of the input More...
fvMesh &	mesh_
	fvMesh More...
const DAOption &	daOption_
	DAOption object. More...
const DAModel &	daModel_
	DAIndex object. More...
const DAIndex &	daIndex_
	DAIndex object. More...
HashTable< wordList >	stateInfo_
	the stateInfo_ list from DAStateInfo object More...

Additional Inherited Members
Static Public Member Functions inherited from DAInput
static autoPtr< DAInput >	New (const word inputName, const word inputType, fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)

Detailed Description

Definition at line 28 of file DAInputField.H.

Constructor & Destructor Documentation

DAInputField()

DAInputField	(	const word	inputName,
		const word	inputType,
		fvMesh &	mesh,
		const DAOption &	daOption,
		const DAModel &	daModel,
		const DAIndex &	daIndex
	)

Definition at line 19 of file DAInputField.C.

References DAInput::daOption_, DAInputField::fieldName_, DAInputField::fieldType_, DAOption::getAllOptions(), and DAInputField::indices_.

Here is the call graph for this function:

~DAInputField()

virtual ~DAInputField ( )

inlinevirtual

Definition at line 56 of file DAInputField.H.

Member Function Documentation

TypeName()

TypeName

(

"field"

)

run()

void run ( const scalarList &  input )

virtual

Implements DAInput.

Definition at line 51 of file DAInputField.C.

References DAInput::daIndex_, DAInputField::distributed(), DAInputField::fieldName_, DAInputField::fieldType_, forAll(), DAIndex::globalCellNumbering, DAInputField::indices_, DAInput::mesh_, and DAIndex::nGlobalCells.

Here is the call graph for this function:

size()

virtual label size ( )

inlinevirtual

Implements DAInput.

Definition at line 62 of file DAInputField.H.

References DAInput::daIndex_, DAInputField::distributed(), DAInputField::fieldType_, DAInputField::indices_, DAIndex::nGlobalCells, and DAIndex::nLocalCells.

Here is the call graph for this function:

distributed()

virtual label distributed ( )

inlinevirtual

Implements DAInput.

Definition at line 94 of file DAInputField.H.

References DAInput::daOption_, DAOption::getAllOptions(), and DAInput::inputName_.

Referenced by DAInputField::run(), and DAInputField::size().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

fieldName_

word fieldName_

protected

name of the field

Definition at line 34 of file DAInputField.H.

Referenced by DAInputField::DAInputField(), and DAInputField::run().

fieldType_

word fieldType_

protected

field type, can be either scalar or vector

Definition at line 37 of file DAInputField.H.

Referenced by DAInputField::DAInputField(), DAInputField::run(), and DAInputField::size().

indices_

labelList indices_

protected

if it is vector fields, we can also provide components/indices

Definition at line 40 of file DAInputField.H.

Referenced by DAInputField::DAInputField(), DAInputField::run(), and DAInputField::size().

---

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

• dafoam/src/adjoint/DAInput/DAInputField.H
• dafoam/src/adjoint/DAInput/DAInputField.C