OpenFOAM: API Guide
v2112
The open source CFD toolbox
Deprecated List
Member
argList::argRead
(const label index) const
(2018-01) - use
get()
method
Member
argList::get
(const word &optName, const T &deflt) const
(2020-05) - use
getOrDefault()
method
Member
argList::lookupOrDefault
(const word &optName, const T &deflt) const
(2020-05) - use
getOrDefault()
method
Member
argList::opt
(const word &optName) const
(2020-05) - use
get()
method
Member
argList::opt
(const word &optName, const T &deflt) const
(2020-05) - use
getOrDefault()
method
Member
argList::optionFound
(const word &optName) const
(2018-01) - use
found()
method
Member
argList::optionLookup
(const word &optName) const
(2018-01) - use lookup() method
Member
argList::optionLookupOrDefault
(const word &optName, const T &deflt) const
(2018-01) - use
getOrDefault()
method
Member
argList::optionRead
(const word &optName) const
(2018-01) - use
get()
method
Member
argList::optionReadIfPresent
(const word &optName, T &val, const T &deflt) const
(2018-01) - use
readIfPresent()
method
Member
argList::optionReadIfPresent
(const word &optName, T &val) const
(2018-01) - use
readIfPresent()
method
Member
argList::optionReadList
(const word &optName) const
(2018-01) - use
getList()
method
Member
argList::read
(const label index) const
(2018-08) - use
get()
method
Member
autoPtr< T >::empty
() const noexcept
(2020-07) - use bool operator
Member
autoPtr< T >::operator const T &
() const
(2019-01) Can result in inadvertent conversions where the user should really know or check if the pointer is valid prior to using.
Member
autoPtr< T >::operator=
(const autoPtr< T > &ap)=delete
(2018-02) can have unintended behaviour
Member
autoPtr< T >::set
(T *p) noexcept
(2018-02) Identical to
reset()
.
Member
bitSet::assign
(const unsigned int val)
(2020-11) use
fill()
Member
blockEdge::appendEndPoints
(const pointField &p, const label from, const label to, const pointField &intermediate)
(2020-10) use
polyLine::concat
Member
blockEdge::blockEdge
(const pointField &points, const label from, const label to)
(2021-11) use constructor with edge
Member
blockMesh::scaleFactor
() const
use inplacePointTransforms or globalPosition instead
Member
cellModeller::lookup
(const label modelIndex)
(2017-11) use
cellModel::ptr
instead
Member
cellModeller::lookup
(const word &modelName)
(2017-11) use
cellModel::ptr
instead
Member
clock::rawDate
()
(2020-05) may be removed in future versions
Member
coordinateSystems::lookupPtr
(const word &name) const
(2020-03) - use
cfind()
method
Member
decompositionModel::decompositionModel
(const
polyMesh
&mesh, const dictionary &dict, const
fileName
&decompDictFile="")
(2021-04)
Member
decompositionModel::New
(const
polyMesh
&mesh, const dictionary &dict, const
fileName
&decompDictFile="")
(2021-04)
Member
decompositionModel::selectIO
(const
IOobject
&io, const
fileName
&file, const word &name="")
(2018-08) - use
IOobject::selectIO
directly
Member
dictionary::found
(const word &keyword, bool recursive, bool patternMatch=true) const
(2018-10) - use
keyType::option
version
Member
dictionary::lookup
(const word &keyword, bool recursive, bool patternMatch=true) const
(2018-10) - use
keyType::option
version
Member
dictionary::lookupEntry
(const word &keyword, bool recursive, bool patternMatch) const
(2018-10) - use
keyType::option
version
Member
dictionary::lookupEntryPtr
(const word &keyword, bool recursive, bool patternMatch) const
(2018-10) - use
keyType::option
version
Member
dictionary::lookupEntryPtr
(const word &keyword, bool recursive, bool patternMatch)
(2018-10) - use
keyType::option
version
Member
dictionary::lookupOrAddDefault
(const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
(2018-10) - use
keyType::option
version
Member
dictionary::lookupOrDefault
(const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
(2018-10) - use
keyType::option
version
Member
dictionary::lookupScopedEntryPtr
(const word &keyword, bool recursive, bool patternMatch) const
(2018-10) - use
keyType::option
version
Member
dictionary::lookupType
(const word &keyword, bool recursive=false, bool patternMatch=true) const
(2018-10) - use
get()
method
Member
dictionary::operator[]
(const word &keyword) const
(2018-07) - use lookup() method
Member
dictionary::readIfPresent
(const word &keyword, T &val, bool recursive, bool patternMatch=true) const
(2018-10) - use
keyType::option
version
Member
dictionary::subDictPtr
(const word &keyword)
(2018-10) - use
findDict()
method
Member
dictionary::subDictPtr
(const word &keyword) const
(2018-10) - use
findDict()
method
Member
DictionaryBase< IDLListType, T >::lookupPtr
(const word &keyword) const
(2020-03) - use
cfind()
method
Member
DictionaryBase< IDLListType, T >::lookupPtr
(const word &keyword)
(2020-03) - use
find()
method
Member
dimensioned< Type >::dimensioned
(
Istream
&is)
(2018-11) - should generally use construct from dictionary or
primitiveEntry
instead (additional checks on the input stream).
Member
dimensioned< Type >::dimensioned
(const word &name,
Istream
&is)
(2018-11) - should generally use construct from dictionary or
primitiveEntry
instead (additional checks on the input stream).
Member
dimensioned< Type >::dimensioned
(const word &name, const
dimensionSet
&dims,
Istream
&is)
(2018-11) - should generally use construct from dictionary or
primitiveEntry
instead (additional checks on the input stream).
Class
edge::Hash< Unused >
(2021-04) - use hasher() functor
Member
ensightCase::options::nodeValues
(bool on) noexcept
(2020-02) -
newData()
with second parameter
Member
Enum< EnumType >::get
(const word &key, const EnumType deflt) const
(2020-11) - use two-parameter lookup() method
Member
Enum< EnumType >::lookup
(const word &key, const dictionary &dict) const
(2018-10) - use two-parameter
get()
method
Member
Enum< EnumType >::operator()
(const EnumType e) const
(2020-11) - use
get()
method
Member
Enum< EnumType >::operator()
(const word &key, const EnumType deflt) const
(2020-11) - use two-parameter lookup() method
Member
face::FOAM_DEPRECATED_FOR
(2018-12, "areaNormal() or unitNormal()") vector normal(const UList< point > &p) const
(2018-06) Deprecated for new use
Member
faMatrix< Type >::faMatrix
(const GeometricField< Type, faPatchField, areaMesh > &psi,
Istream
&is)
(2022-05) - construct with
dimensionSet
instead
Member
fileName::name
(const bool noExt) const
(2017-03) - use
name()
or
nameLessExt()
methods which describe their behaviour explicitly
Class
FixedList< T, N >::Hash< Unused >
(2021-04) - use hasher() functor
Member
Foam::dimVol
(dimVolume)
(2019-01) use dimVolume instead
Member
Foam::domainName
()
(2022-01) - avoid usage entirely
Member
Foam::emptyLabelList
(2019-02) use
labelList::null()
instead
Member
Foam::env
(const std::string &envName)
(2020-05) - use
hasEnv()
function
Member
Foam::findIndex
(const ListType &input, typename ListType::const_reference val, const label start=0)
(2017-10) - use the
UList
find/found methods
Member
Foam::findStrings
(const char *disallowed, const
UList< StringType >
&input, const bool invert=false)=delete
(2018-02) Treating string as regex may be inefficient and lead to unintended results. Use regExp,
keyType
,
wordRe
instead, or
findMatchingStrings()
Member
Foam::findStrings
(const std::string &disallowed, const
UList< StringType >
&input, const bool invert=false)=delete
(2018-02) Treating string as regex may be inefficient and lead to unintended results. Use regExp,
keyType
,
wordRe
instead, or
findMatchingStrings()
Member
Foam::hostName
(bool full)
(2022-01) - use hostname() function without parameter
Member
Foam::inplaceSubsetStrings
(const char *disallowed, StringListType &input, const bool invert=false)=delete
(2018-02) Treating string as regex may be inefficient and lead to unintended results. Use regExp,
keyType
,
wordRe
instead, or
inplaceSubsetMatchingStrings()
Member
Foam::inplaceSubsetStrings
(const std::string &disallowed, StringListType &input, const bool invert=false)=delete
(2018-02) Treating string as regex may be inefficient and lead to unintended results. Use
keyType
,
wordRe
instead, or
inplaceSubsetMatchingStrings()
Member
Foam::mergePoints
(const PointList &points, const scalar mergeTol, const bool verbose, labelList &pointMap, List< typename PointList::value_type > &newPoints, typename PointList::value_type origin)
(2022-03) reference point is ignored
Member
Foam::mergePoints
(const PointList &points, const scalar mergeTol, const bool verbose, labelList &pointMap, typename PointList::value_type origin)
(2022-03) reference point is ignored
Member
Foam::nil
(2017-05) - use
Foam::zero::null
instead
Member
Foam::operator<<
(
ensightGeoFile
&, const
ensightPart
&)=delete
(2020-02) - use
ensightOutput
or member
write()
methods
Member
Foam::subsetStrings
(const char *disallowed, const StringListType &input, const bool invert=false)=delete
(2018-02) Treating string as regex may be inefficient and lead to unintended results. Use regExp,
keyType
,
wordRe
instead, or
subsetMatchingStrings()
Member
Foam::subsetStrings
(const std::string &disallowed, const StringListType &input, const bool invert=false)=delete
(2018-02) Treating string as regex may be inefficient and lead to unintended results. Use regExp,
keyType
,
wordRe
instead, or
subsetMatchingStrings()
Member
Foam::wordReListMatcher
(2017-05) - use
Foam::wordRes
instead
Member
formatter::openDataArray
(const
vtk::dataArrayAttr
&dataName)
Use beginDataArray instead (SEPT-2018)
Member
formatter::openDataArray
(const word &dataName)
Use beginDataArray instead (SEPT-2018)
Member
fvMatrix< Type >::fvMatrix
(const GeometricField< Type, fvPatchField, volMesh > &psi,
Istream
&is)
(2022-05) - construct with
dimensionSet
instead
Member
GeometricField< Type, PatchField, GeoMesh >::maxMin
(const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal)
(2019-01) identical to
clip()
Member
geometricSurfacePatch::geometricSurfacePatch
(const word &geometricType, const word &name, const label index)
(2020-01) - order inconsistent with other identifiers
Member
geometricSurfacePatch::geometricSurfacePatch
(
Istream
&is, const label index)=delete
(2020-01) - unused, inconsistent
Member
geometricSurfacePatch::writeDict
(
Ostream
&os) const
(2020-01) - Write dictionary
Class
getNameOp< T >
(2020-11) use
nameOp
Class
getTypeOp< T >
(2020-11) use
typeOp
Class
globalMeshData::ListPlusEqOp< T >
(2020-09) - use
ListOps::appendEqOp
Member
hashedWordList::contains
(const word &val) const
(2019-01) - use
found()
method
Member
interpolation2DTable< Type >::checkOrder
() const
(2019-08) - older name for
check()
method
Member
IOobject::globalObject
() noexcept
(2021-03) - use
globalObject(bool)
Member
IOobject::readOpt
() noexcept
(2021-03) - use
readOpt(readOption)
Member
IOobject::registerObject
() noexcept
(2021-03) - use
registerObject(bool)
Member
IOobject::writeOpt
() noexcept
(2021-03) - use
writeOpt(writeOption)
Member
IOobjectList::lookup
(const char *objName) const
(2018-11) use
findObject()
for non-ambiguous resolution
Member
IOobjectList::lookup
(const word &objName) const
(2018-11) use
findObject()
for non-ambiguous resolution
Member
keyType::keyType
(const std::string &s, bool isPattern)
(2019-08) - use Construct with option
Member
labelRange::valid
() const noexcept
(2020-09) - use bool operator
Member
LduMatrix< Type, DType, LUType >::solver::readControl
(const dictionary &dict, T &val, const word &key)
(2021-09) - use dictionary methods directly
Member
Matrix< Form, Type >::block
(const label m, const label n, const label mStart, const label nStart)
(2019-04) - use
subMatrix()
Member
Matrix< Form, Type >::block
(const label m, const label n, const label mStart, const label nStart) const
(2019-04) - use
subMatrix()
Member
Matrix< Form, Type >::col
(const label m, const label rowStart)=delete
(2019-04) - use
subColumn()
Member
Matrix< Form, Type >::col
(const label m, const label rowStart) const =delete
(2019-04) - use
subColumn()
Member
Matrix< Form, Type >::col
(const label m, const label mStart, const label nStart)
(2019-04) - use
subColumn()
Member
Matrix< Form, Type >::col
(const label m, const label mStart, const label nStart) const
(2019-04) - use
subColumn()
Member
Matrix< Form, Type >::v
()
(2019-04) - use
data()
method
Member
Matrix< Form, Type >::v
() const
(2019-04) - use
cdata()
method
Class
NamedEnum< EnumType, nEnum >
(2017-05) This class is retained for compatibility only and should be used for any new code. The
Foam::Enum
class is robuster, more flexible, easier to use.
Member
objectRegistry::lookupObjectPtr
(const word &name, bool recursive=false) const
(2018-10) - use
findObject()
method
Member
objectRegistry::lookupObjectRefPtr
(const word &name, bool recursive=false) const
(2018-10) - use
getObjectPtr()
method
Member
OSHA1stream::rewind
()
(2017-07) - use
reset()
method
Member
PackedList< Width >::assign
(const unsigned int val)
(2020-11) use
fill()
Member
PackedList< Width >::assign
(const PackedList< Width > &rhs)
(2020-11) use operator=
Member
PointHit< PointType >::rawPoint
() const noexcept
(2020-10) use
point()
Member
PrimitivePatch< FaceList, PointField >::FaceType
(2020-03) prefer face_type typedef
Member
refPtr< T >::empty
() const noexcept
(2020-07) - use bool operator
Class
regExpPosix
This class will be superseded by
Foam::regExpCxx
as compiler support for regular expressions continues to improve.
Member
regionFunctionObject::lookupObjectPtr
(const word &fieldName) const
(2018-10) - use
findObject()
method
Member
regionFunctionObject::lookupObjectRefPtr
(const word &fieldName) const
(2018-10) - use
getObjectPtr()
method
Member
simpleObjectRegistry::setNamedInt
(std::string name, int val, bool report=false)
(2021-09) renamed to setNamedValue
Member
string::endsWith
(const std::string &s) const
(2019-11) use ends_with instead
Class
string::hash
(2021-04) - use hasher
Member
string::removeTrailing
(const char c)
(2019-11) use removeEnd instead
Member
string::startsWith
(const std::string &s) const
(2019-11) use starts_with instead
Member
surfacePatch::surfacePatch
(
Istream
&is, const label index)=delete
(2020-01) - unused, inconsistent
Member
surfacePatch::surfacePatch
(const word &geometricType, const word &name, const label size, const label start, const label index)
(2020-01) - order inconsistent with other identifiers
Member
surfacePatch::writeDict
(
Ostream
&os) const
(2020-01) -
Ostream
output
Member
surfZone::surfZone
(
Istream
&is, const label index)=delete
(2020-01) - unused, inconsistent
Member
surfZone::writeDict
(
Ostream
&os) const
(2020-01) - Write dictionary
Member
Switch::FOAM_DEPRECATED_FOR
(2019-02, "good() or static found() method") bool valid() const noexcept
(2020-01) Use
good()
method, or static
found()
method
Member
Switch::Switch
(const char *str, bool allowBad)
(2020-01) - confusing syntax, use static
find()
method
Member
Switch::Switch
(const std::string &str, bool allowBad)
(2020-01) - confusing syntax, use static
find()
method
Member
Tensor2D< Cmpt >::vectorComponent
(const direction cmpt) const
(2018-12) use
row()
method
Member
Tensor< Cmpt >::vectorComponent
(const direction cmpt) const
(2018-12) use
row()
method
Member
TimeState::outputTime
() const noexcept
(2016-05) - use
writeTime()
method
Member
tmp< T >::empty
() const noexcept
(2020-07) - use bool operator
Member
token::doubleScalarToken
() const
(2020-01) -
doubleToken()
Member
token::floatScalarToken
() const
(2020-01) -
floatToken()
Member
token::isDoubleScalar
() const
(2020-01) -
isDouble()
Member
token::isFloatScalar
() const
(2020-01) -
isFloat()
Member
token::lineNumber
() noexcept
(2021-03) - use
lineNumber(label)
Member
token::operator=
(string *)=delete
(2017-11) - use move assign from string
Member
token::operator=
(word *)=delete
(2017-11) - use move assign from word
Member
topoSet::deleteSet
(const
topoSet
&set)
(2018-10) - use subtractSet instead
Member
topoSetSource::DELETE
(2018-10) Alias for SUBTRACT
Member
topoSetSource::toAction
(const word &actionName)
(2018-07) - use actionNames[] directly
Member
triangle< Point, PointRef >::FOAM_DEPRECATED_FOR
(2018-12, "areaNormal() or unitNormal()") vector normal() const
(2018-06) Deprecated for new use
Member
triFace::FOAM_DEPRECATED_FOR
(2018-12, "areaNormal() or unitNormal()") vector normal(const UList< point > &points) const
(2018-06) Deprecated for new use
Class
triFace::Hash< Unused >
(2021-04) - use hasher() functor
Class
UList< T >::Hash< Unused >
(2021-04) - use hasher() functor
Member
UPstream::firstSlave
() noexcept
(2020-09) use
subProcs()
method instead
Member
UPstream::lastSlave
(const label communicator=worldComm)
(2020-09) use
subProcs()
method instead
Member
wordRe::NOCASE
(2018-04) Alias for ICASE
Generated by
1.9.5
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.