OOF2: The Manual

getField
Prev  Field Classes and Functions  Next

Name

getField — Retrieve a Field object by name

Synopses

C++

#include "engine/field.h"
static Field* Field::getField(const std::string& name);

Python

from ooflib.SWIG.engine import field
f = field.getField(name)

Source Files

  • SRC/engine/field.h: C++ headers
  • SRC/engine/field.C: C++ code
  • SRC/engine/field.swg: SWIG source code
  • SRC/engine/field.spy: Python code included in field.swg.

Parameters

name

The name of an existing Field.

Description

getField returns a previously created Field object. In C++ it returns a pointer to the base class, which may be cast to the derived class: 

ScalarField *T = dynamic_cast<ScalarField*>(getField("Temperature"));

In Python, it returns a reference to an object of the appropriate derived class: 

>>> T = getField("Temperature")
>>> type(T)
<class 'ooflib.SWIG.engine.field.ScalarField'>

getFlux is defined in the main OOF2 namespace so that it can be used freely in scripts, text mode and the Console Window.

Prev  Up  Next
ThreeVectorField  Home  Flux Classes and Functions