ENH: simplify objectRegistry access names (issue #322)

New name: findObject(), cfindObject() Old name: lookupObjectPtr() Return a const pointer or nullptr on failure. New name: findObject() Old name: -- Return a non-const pointer or nullptr on failure. New name: getObjectPtr() Old name: lookupObjectRefPtr() Return a non-const pointer or nullptr on failure. Can be called on a const object and it will perform a const_cast. - use these updated names and functionality in more places NB: The older methods names are deprecated, but continue to be defined.
2025-11-28 03:28:01 +00:00 · 2018-10-17 16:44:10 +02:00
parent e0255cfff2
commit 8fabc32539
94 changed files with 918 additions and 952 deletions
--- a/src/sampling/sampledSurface/isoSurface/sampledIsoSurface.C
+++ b/src/sampling/sampledSurface/isoSurface/sampledIsoSurface.C
@ -52,27 +52,22 @@ void Foam::sampledIsoSurface::getIsoFields() const
    // Get volField
    // ~~~~~~~~~~~~

-    if (fvm.foundObject<volScalarField>(isoField_))
+    volFieldPtr_ = fvm.getObjectPtr<volScalarField>(isoField_);
+
+    if (volFieldPtr_)
    {
-        if (debug)
-        {
-            InfoInFunction
-                << "Lookup volField " << isoField_ << endl;
-        }
+        DebugInFunction
+            << "Lookup volField " << isoField_ << endl;
+
        storedVolFieldPtr_.clear();
-        volFieldPtr_ = &fvm.lookupObject<volScalarField>(isoField_);
    }
    else
    {
        // Bit of a hack. Read field and store.

-        if (debug)
-        {
-            InfoInFunction
-                << "Checking " << isoField_
-                << " for same time " << fvm.time().timeName()
-                << endl;
-        }
+        DebugInFunction
+            << "Checking " << isoField_
+            << " for same time " << fvm.time().timeName() << endl;

        if
        (
@ -80,13 +75,9 @@ void Foam::sampledIsoSurface::getIsoFields() const
         || (fvm.time().timeName() != storedVolFieldPtr_().instance())
        )
        {
-            if (debug)
-            {
-                InfoInFunction
-                    << "Reading volField " << isoField_
-                    << " from time " << fvm.time().timeName()
-                    << endl;
-            }
+            DebugInFunction
+                << "Reading volField " << isoField_
+                << " from time " << fvm.time().timeName() << endl;

            IOobject vfHeader
            (
@ -141,61 +132,45 @@ void Foam::sampledIsoSurface::getIsoFields() const
          + isoField_
          + ')';

-        if (fvm.foundObject<pointScalarField>(pointFldName))
-        {
-            if (debug)
-            {
-                InfoInFunction
-                    << "lookup pointField " << pointFldName << endl;
-            }
-            const pointScalarField& pfld = fvm.lookupObject<pointScalarField>
-            (
-                pointFldName
-            );

-            if (!pfld.upToDate(*volFieldPtr_))
+        pointFieldPtr_ = fvm.getObjectPtr<pointScalarField>(pointFldName);
+
+        if (pointFieldPtr_)
+        {
+            DebugInFunction
+                << "lookup pointField " << pointFldName << endl;
+
+            if (!pointFieldPtr_->upToDate(*volFieldPtr_))
            {
-                if (debug)
-                {
-                    InfoInFunction
-                        << "updating pointField "
-                        << pointFldName << endl;
-                }
+                DebugInFunction
+                    << "updating pointField " << pointFldName << endl;
+
                // Update the interpolated value
                volPointInterpolation::New(fvm).interpolate
                (
                    *volFieldPtr_,
-                    const_cast<pointScalarField&>(pfld)
+                    const_cast<pointScalarField&>(*pointFieldPtr_)
                );
            }
-
-            pointFieldPtr_ = &pfld;
        }
        else
        {
            // Not in registry. Interpolate.

-            if (debug)
-            {
-                InfoInFunction
-                    << "Checking pointField " << pointFldName
-                    << " for same time " << fvm.time().timeName()
-                    << endl;
-            }
+            DebugInFunction
+                << "creating pointField " << pointFldName << endl;

            // Interpolate without cache. Note that we're registering it
            // below so next time round it goes into the condition
            // above.
-            tmp<pointScalarField> tpfld
-            (
+            pointFieldPtr_ =
                volPointInterpolation::New(fvm).interpolate
                (
                    *volFieldPtr_,
                    pointFldName,
                    false
-                )
-            );
-            pointFieldPtr_ = tpfld.ptr();
+                ).ptr();
+
            const_cast<pointScalarField*>(pointFieldPtr_)->store();
        }

@ -212,17 +187,13 @@ void Foam::sampledIsoSurface::getIsoFields() const
        }


-        if (debug)
-        {
-            InfoInFunction
-                << "volField " << volFieldPtr_->name()
-                << " min:" << min(*volFieldPtr_).value()
-                << " max:" << max(*volFieldPtr_).value() << endl;
-            InfoInFunction
-                << "pointField " << pointFieldPtr_->name()
-                << " min:" << gMin(pointFieldPtr_->primitiveField())
-                << " max:" << gMax(pointFieldPtr_->primitiveField()) << endl;
-        }
+        DebugInFunction
+            << "volField " << volFieldPtr_->name()
+            << " min:" << min(*volFieldPtr_).value()
+            << " max:" << max(*volFieldPtr_).value() << nl
+            << "pointField " << pointFieldPtr_->name()
+            << " min:" << gMin(pointFieldPtr_->primitiveField())
+            << " max:" << gMax(pointFieldPtr_->primitiveField()) << endl;
    }
    else
    {
@ -231,24 +202,20 @@ void Foam::sampledIsoSurface::getIsoFields() const

        // Either lookup on the submesh or subset the whole-mesh volField

-        if (subFvm.foundObject<volScalarField>(isoField_))
+        volSubFieldPtr_ = subFvm.getObjectPtr<volScalarField>(isoField_);
+
+        if (volSubFieldPtr_)
        {
-            if (debug)
-            {
-                InfoInFunction
-                    << "Sub-mesh lookup volField "
-                    << isoField_ << endl;
-            }
+            DebugInFunction
+                << "Sub-mesh lookup volField " << isoField_ << endl;
+
            storedVolSubFieldPtr_.clear();
-            volSubFieldPtr_ = &subFvm.lookupObject<volScalarField>(isoField_);
        }
        else
        {
-            if (debug)
-            {
-                InfoInFunction
-                    << "Sub-setting volField " << isoField_ << endl;
-            }
+            DebugInFunction
+                << "Sub-setting volField " << isoField_ << endl;
+
            storedVolSubFieldPtr_.reset
            (
                subMeshPtr_().interpolate
@ -270,53 +237,40 @@ void Foam::sampledIsoSurface::getIsoFields() const
          + volSubFieldPtr_->name()
          + ')';

-        if (subFvm.foundObject<pointScalarField>(pointFldName))
-        {
-            if (debug)
-            {
-                InfoInFunction
-                    << "Sub-mesh lookup pointField " << pointFldName << endl;
-            }
-            const pointScalarField& pfld = subFvm.lookupObject<pointScalarField>
-            (
-                pointFldName
-            );

-            if (!pfld.upToDate(*volSubFieldPtr_))
+        pointFieldPtr_ = subFvm.getObjectPtr<pointScalarField>(pointFldName);
+
+        if (pointFieldPtr_)
+        {
+            DebugInFunction
+                << "Sub-mesh lookup pointField " << pointFldName << endl;
+
+            if (!pointFieldPtr_->upToDate(*volSubFieldPtr_))
            {
-                if (debug)
-                {
-                    Info<< "sampledIsoSurface::getIsoFields() :"
-                        << " updating submesh pointField "
-                        << pointFldName << endl;
-                }
+                DebugInFunction
+                    << "Updating submesh pointField " << pointFldName << endl;
+
                // Update the interpolated value
                volPointInterpolation::New(subFvm).interpolate
                (
                    *volSubFieldPtr_,
-                    const_cast<pointScalarField&>(pfld)
+                    const_cast<pointScalarField&>(*pointFieldPtr_)
                );
            }
-
-            pointFieldPtr_ = &pfld;
        }
        else
        {
-            if (debug)
-            {
-                InfoInFunction
-                    << "Interpolating submesh volField "
-                    << volSubFieldPtr_->name()
-                    << " to get submesh pointField " << pointFldName << endl;
-            }
-            tmp<pointScalarField> tpfld
-            (
+            DebugInFunction
+                << "Interpolating submesh volField "
+                << volSubFieldPtr_->name()
+                << " to get submesh pointField " << pointFldName << endl;
+
+            pointSubFieldPtr_ =
                volPointInterpolation::New
                (
                    subFvm
-                ).interpolate(*volSubFieldPtr_)
-            );
-            pointSubFieldPtr_ = tpfld.ptr();
+                ).interpolate(*volSubFieldPtr_).ptr();
+
            const_cast<pointScalarField*>(pointSubFieldPtr_)->store();
        }

@ -333,19 +287,15 @@ void Foam::sampledIsoSurface::getIsoFields() const
        }


-        if (debug)
-        {
-            InfoInFunction
-                << "volSubField "
-                << volSubFieldPtr_->name()
-                << " min:" << min(*volSubFieldPtr_).value()
-                << " max:" << max(*volSubFieldPtr_).value() << endl;
-            InfoInFunction
-                << "pointSubField "
-                << pointSubFieldPtr_->name()
-                << " min:" << gMin(pointSubFieldPtr_->primitiveField())
-                << " max:" << gMax(pointSubFieldPtr_->primitiveField()) << endl;
-        }
+        DebugInFunction
+            << "volSubField "
+            << volSubFieldPtr_->name()
+            << " min:" << min(*volSubFieldPtr_).value()
+            << " max:" << max(*volSubFieldPtr_).value() << nl
+            << "pointSubField "
+            << pointSubFieldPtr_->name()
+            << " min:" << gMin(pointSubFieldPtr_->primitiveField())
+            << " max:" << gMax(pointSubFieldPtr_->primitiveField()) << endl;
    }
 }

--- a/src/sampling/sampledSurface/isoSurface/sampledIsoSurfaceCell.C
+++ b/src/sampling/sampledSurface/isoSurface/sampledIsoSurfaceCell.C
@ -64,7 +64,7 @@ bool Foam::sampledIsoSurfaceCell::updateGeometry() const

    // Use field from database, or try to read it in

-    const auto* cellFldPtr = fvm.lookupObjectPtr<volScalarField>(isoField_);
+    const auto* cellFldPtr = fvm.findObject<volScalarField>(isoField_);

    if (debug)
    {
--- a/src/sampling/sampledSurface/thresholdCellFaces/sampledThresholdCellFaces.C
+++ b/src/sampling/sampledSurface/thresholdCellFaces/sampledThresholdCellFaces.C
@ -61,7 +61,7 @@ bool Foam::sampledThresholdCellFaces::updateGeometry() const

    // Use volField from database, or try to read it in

-    const auto* cellFldPtr = fvm.lookupObjectPtr<volScalarField>(fieldName_);
+    const auto* cellFldPtr = fvm.findObject<volScalarField>(fieldName_);

    if (debug)
    {
--- a/src/sampling/surfMeshSample/distanceSurface/surfMeshSampleDistanceSurfaceTemplates.C
+++ b/src/sampling/surfMeshSample/distanceSurface/surfMeshSampleDistanceSurfaceTemplates.C
@ -53,7 +53,7 @@ bool Foam::surfMeshSampleDistanceSurface::sampleType
 {
    typedef GeometricField<Type, fvPatchField, volMesh> VolFieldType;

-    const auto* volFldPtr = mesh().lookupObjectPtr<VolFieldType>(fieldName);
+    const auto* volFldPtr = mesh().findObject<VolFieldType>(fieldName);

    if (!volFldPtr)
    {
--- a/src/sampling/surfMeshSample/plane/surfMeshSamplePlaneTemplates.C
+++ b/src/sampling/surfMeshSample/plane/surfMeshSamplePlaneTemplates.C
@ -53,7 +53,7 @@ bool Foam::surfMeshSamplePlane::sampleType
 {
    typedef GeometricField<Type, fvPatchField, volMesh> VolFieldType;

-    const auto* volFldPtr = mesh().lookupObjectPtr<VolFieldType>(fieldName);
+    const auto* volFldPtr = mesh().findObject<VolFieldType>(fieldName);

    if (!volFldPtr)
    {
--- a/src/sampling/surfMeshSample/surfMeshSample/surfMeshSampleTemplates.C
+++ b/src/sampling/surfMeshSample/surfMeshSample/surfMeshSampleTemplates.C
@ -76,7 +76,7 @@ Foam::surfMeshSample::getOrCreateSurfField
    const surfMesh& surf  = surface();
    const word& fieldName = vField.name();

-    SurfFieldType* ptr = surf.lookupObjectRefPtr<SurfFieldType>(fieldName);
+    SurfFieldType* ptr = surf.getObjectPtr<SurfFieldType>(fieldName);
    if (!ptr)
    {
        ptr = new SurfFieldType
--- a/src/sampling/surfMeshSample/surfMeshSamplers/surfMeshSamplers.C
+++ b/src/sampling/surfMeshSample/surfMeshSamplers/surfMeshSamplers.C
@ -109,7 +109,7 @@ bool Foam::surfMeshSamplers::add_rhoU(const word& derivedName)

    // rhoU = rho * U

-    const auto* rhoPtr = mesh_.lookupObjectPtr<volScalarField>("rho");
+    const auto* rhoPtr = mesh_.findObject<volScalarField>("rho");
    const volVectorField& U = mesh_.lookupObject<volVectorField>("U");

    tmp<volVectorField> tresult;
@ -152,7 +152,7 @@ bool Foam::surfMeshSamplers::add_pTotal(const word& derivedName)

    // pTotal = p + rho * U^2 / 2

-    const auto* rhoPtr = mesh_.lookupObjectPtr<volScalarField>("rho");
+    const auto* rhoPtr = mesh_.findObject<volScalarField>("rho");
    const volScalarField& p = mesh_.lookupObject<volScalarField>("p");
    const volVectorField& U = mesh_.lookupObject<volVectorField>("U");

--- a/src/sampling/surfMeshSample/triSurfaceMesh/surfMeshSampleDiscreteTemplates.C
+++ b/src/sampling/surfMeshSample/triSurfaceMesh/surfMeshSampleDiscreteTemplates.C
@ -60,7 +60,7 @@ bool Foam::surfMeshSampleDiscrete::sampleType
    typedef GeometricField<Type, fvPatchField, volMesh> VolFieldType;

    const auto* volFldPtr =
-        SurfaceSource::mesh().lookupObjectPtr<VolFieldType>(fieldName);
+        SurfaceSource::mesh().findObject<VolFieldType>(fieldName);

    if (!volFldPtr)
    {
--- a/src/sampling/surface/triSurfaceMesh/discreteSurfaceTemplates.C
+++ b/src/sampling/surface/triSurfaceMesh/discreteSurfaceTemplates.C
@ -40,7 +40,7 @@ bool Foam::discreteSurface::sampleType
    typedef DimensionedField<Type, surfGeoMesh> SurfFieldType;
    typedef IOField<Type> TmpFieldType;

-    const auto* volFldPtr = mesh().lookupObjectPtr<VolFieldType>(fieldName);
+    const auto* volFldPtr = mesh().findObject<VolFieldType>(fieldName);

    if (!volFldPtr)
    {
@ -57,7 +57,7 @@ bool Foam::discreteSurface::sampleType
    {
        const surfMesh& surf = dynamicCast<const surfMesh>(obr);

-        SurfFieldType* ptr = surf.lookupObjectRefPtr<SurfFieldType>(fieldName);
+        SurfFieldType* ptr = surf.getObjectPtr<SurfFieldType>(fieldName);
        if (!ptr)
        {
            // Doesn't exist or the wrong type
@ -83,7 +83,7 @@ bool Foam::discreteSurface::sampleType
    }
    else
    {
-        TmpFieldType* ptr = obr.lookupObjectRefPtr<TmpFieldType>(fieldName);
+        TmpFieldType* ptr = obr.getObjectPtr<TmpFieldType>(fieldName);
        if (!ptr)
        {
            // Doesn't exist or the wrong type
@ -121,7 +121,7 @@ Foam::discreteSurface::sampleType
 {
    typedef GeometricField<Type, fvPatchField, volMesh> VolFieldType;

-    const auto* volFldPtr = mesh().lookupObjectPtr<VolFieldType>(fieldName);
+    const auto* volFldPtr = mesh().findObject<VolFieldType>(fieldName);

    if (volFldPtr)
    {