2406/GeometricFieldNew_8C_source.html

 /*---------------------------------------------------------------------------*\
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | www.openfoam.com
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
     Copyright (C) 2017 OpenFOAM Foundation
     Copyright (C) 2019-2024 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.

     OpenFOAM is free software: you can redistribute it and/or modify it
     under the terms of the GNU General Public License as published by
     the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.

     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
     for more details.

     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 \*---------------------------------------------------------------------------*/

 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

 template<class Type, template<class> class PatchField, class GeoMesh>
 template<class... Args>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New_impl
 (
     IOobjectOption::registerOption regOpt,
     const word& name,
     const Mesh& mesh,
     Args&&... args
 )
 {
     auto ptr = tmp<GeometricField<Type, PatchField, GeoMesh>>::New
     (
         // == mesh.thisDb().newIOobject(name)
         IOobject
         (
             name,
             mesh.thisDb().time().timeName(),
             mesh.thisDb(),
             IOobjectOption::NO_READ,
             IOobjectOption::NO_WRITE,
             IOobjectOption::NO_REGISTER
         ),
         mesh,
         std::forward<Args>(args)...
     );

     // Registration
     {
         if (IOobjectOption::REGISTER == regOpt)
         {
             ptr->checkIn();
         }
         else if
         (
             // LEGACY_REGISTER: detect if caching is desired
             (IOobjectOption::LEGACY_REGISTER == regOpt)
          && ptr->db().is_cacheTemporaryObject(ptr.get())
         )
         {
             ptr.protect(true);
             ptr->checkIn();
         }
     }
     return ptr;
 }


 // * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //

 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     IOobjectOption::registerOption regOpt,
     const Mesh& mesh,
     const dimensionSet& dims,
     const word& patchFieldType
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         regOpt,
         name,
         mesh,
         dims,
         patchFieldType
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     const Mesh& mesh,
     const dimensionSet& dims,
     const word& patchFieldType
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         IOobjectOption::LEGACY_REGISTER,
         name,
         mesh,
         dims,
         patchFieldType
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     IOobjectOption::registerOption regOpt,
     const Mesh& mesh,
     const dimensionSet& dims,
     const Field<Type>& iField,
     const word& patchFieldType
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         regOpt,
         name,
         mesh,
         dims,
         iField,
         patchFieldType
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     const Mesh& mesh,
     const dimensionSet& dims,
     const Field<Type>& iField,
     const word& patchFieldType
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         IOobjectOption::LEGACY_REGISTER,
         name,
         mesh,
         dims,
         iField,
         patchFieldType
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     IOobjectOption::registerOption regOpt,
     const Mesh& mesh,
     const dimensionSet& dims,
     Field<Type>&& iField,
     const word& patchFieldType
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         regOpt,
         name,
         mesh,
         dims,
         std::move(iField),
         patchFieldType
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     const Mesh& mesh,
     const dimensionSet& dims,
     Field<Type>&& iField,
     const word& patchFieldType
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         IOobjectOption::LEGACY_REGISTER,
         name,
         mesh,
         dims,
         std::move(iField),
         patchFieldType
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     IOobjectOption::registerOption regOpt,
     const Mesh& mesh,
     const dimensionSet& dims,
     const Field<Type>& iField,
     const PtrList<PatchField<Type>>& pflds
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         regOpt,
         name,
         mesh,
         dims,
         iField,
         pflds
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     const Mesh& mesh,
     const dimensionSet& dims,
     const Field<Type>& iField,
     const PtrList<PatchField<Type>>& pflds
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         IOobjectOption::LEGACY_REGISTER,
         name,
         mesh,
         dims,
         iField,
         pflds
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     IOobjectOption::registerOption regOpt,
     const Mesh& mesh,
     const dimensionSet& dims,
     Field<Type>&& iField,
     const PtrList<PatchField<Type>>& pflds
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         regOpt,
         name,
         mesh,
         dims,
         std::move(iField),
         pflds
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     const Mesh& mesh,
     const dimensionSet& dims,
     Field<Type>&& iField,
     const PtrList<PatchField<Type>>& pflds
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         IOobjectOption::LEGACY_REGISTER,
         name,
         mesh,
         dims,
         std::move(iField),
         pflds
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     IOobjectOption::registerOption regOpt,
     const Mesh& mesh,
     const Type& value,
     const dimensionSet& dims,
     const word& patchFieldType
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         regOpt,
         name,
         mesh,
         value,
         dims,
         patchFieldType
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     const Mesh& mesh,
     const Type& value,
     const dimensionSet& dims,
     const word& patchFieldType
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         IOobjectOption::LEGACY_REGISTER,
         name,
         mesh,
         value,
         dims,
         patchFieldType
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     IOobjectOption::registerOption regOpt,
     const Mesh& mesh,
     const Type& value,
     const dimensionSet& dims,
     const wordList& patchFieldTypes,
     const wordList& actualPatchTypes
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         regOpt,
         name,
         mesh,
         value,
         dims,
         patchFieldTypes,
         actualPatchTypes
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     const Mesh& mesh,
     const Type& value,
     const dimensionSet& dims,
     const wordList& patchFieldTypes,
     const wordList& actualPatchTypes
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New_impl
     (
         IOobjectOption::LEGACY_REGISTER,
         name,
         mesh,
         value,
         dims,
         patchFieldTypes,
         actualPatchTypes
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     IOobjectOption::registerOption regOpt,
     const Mesh& mesh,
     const dimensioned<Type>& dt,
     const word& patchFieldType
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New
     (
         name,
         regOpt,
         mesh,
         dt.value(),
         dt.dimensions(),
         patchFieldType
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     const Mesh& mesh,
     const dimensioned<Type>& dt,
     const word& patchFieldType
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New
     (
         name,
         mesh,
         dt.value(),
         dt.dimensions(),
         patchFieldType
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     IOobjectOption::registerOption regOpt,
     const Mesh& mesh,
     const dimensioned<Type>& dt,
     const wordList& patchFieldTypes,
     const wordList& actualPatchTypes
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New
     (
         name,
         regOpt,
         mesh,
         dt.value(),
         dt.dimensions(),
         patchFieldTypes,
         actualPatchTypes
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     const Mesh& mesh,
     const dimensioned<Type>& dt,
     const wordList& patchFieldTypes,
     const wordList& actualPatchTypes
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New
     (
         name,
         mesh,
         dt.value(),
         dt.dimensions(),
         patchFieldTypes,
         actualPatchTypes
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     IOobjectOption::registerOption regOpt,
     const tmp<GeometricField<Type, PatchField, GeoMesh>>& tfld
 )
 {
     auto ptr = tmp<GeometricField<Type, PatchField, GeoMesh>>::New
     (
         IOobject
         (
             name,
             tfld().instance(),
             tfld().local(),
             tfld().db(),
             IOobjectOption::NO_READ,
             IOobjectOption::NO_WRITE,
             IOobjectOption::NO_REGISTER
         ),
         tfld
     );

     // Registration
     {
         if (IOobjectOption::REGISTER == regOpt)
         {
             ptr->checkIn();
         }
         else if
         (
             // LEGACY_REGISTER: detect if caching is desired
             (IOobjectOption::LEGACY_REGISTER == regOpt)
          && ptr->db().is_cacheTemporaryObject(ptr.get())
         )
         {
             ptr.protect(true);
             ptr->checkIn();
         }
     }
     return ptr;
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     const tmp<GeometricField<Type, PatchField, GeoMesh>>& tfld
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New
     (
         name,
         IOobjectOption::LEGACY_REGISTER,
         tfld
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     IOobjectOption::registerOption regOpt,
     const tmp<GeometricField<Type, PatchField, GeoMesh>>& tfld,
     const word& patchFieldType
 )
 {
     auto ptr = tmp<GeometricField<Type, PatchField, GeoMesh>>::New
     (
         IOobject
         (
             name,
             tfld().instance(),
             tfld().local(),
             tfld().db(),
             IOobjectOption::NO_READ,
             IOobjectOption::NO_WRITE,
             IOobjectOption::NO_REGISTER
         ),
         tfld,
         patchFieldType
     );

     // Registration
     {
         if (IOobjectOption::REGISTER == regOpt)
         {
             ptr->checkIn();
         }
         else if
         (
             // LEGACY_REGISTER: detect if caching is desired
             (IOobjectOption::LEGACY_REGISTER == regOpt)
          && ptr->db().is_cacheTemporaryObject(ptr.get())
         )
         {
             ptr.protect(true);
             ptr->checkIn();
         }
     }
     return ptr;
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     const tmp<GeometricField<Type, PatchField, GeoMesh>>& tfld,
     const word& patchFieldType
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New
     (
         name,
         IOobjectOption::LEGACY_REGISTER,
         tfld,
         patchFieldType
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     IOobjectOption::registerOption regOpt,
     const tmp<GeometricField<Type, PatchField, GeoMesh>>& tfld,
     const wordList& patchFieldTypes,
     const wordList& actualPatchTypes
 )
 {
     auto ptr = tmp<GeometricField<Type, PatchField, GeoMesh>>::New
     (
         IOobject
         (
             name,
             tfld().instance(),
             tfld().local(),
             tfld().db(),
             IOobjectOption::NO_READ,
             IOobjectOption::NO_WRITE,
             IOobjectOption::NO_REGISTER
         ),
         tfld,
         patchFieldTypes,
         actualPatchTypes
     );

     // Registration
     {
         if (IOobjectOption::REGISTER == regOpt)
         {
             ptr->checkIn();
         }
         else if
         (
             // LEGACY_REGISTER: detect if caching is desired
             (IOobjectOption::LEGACY_REGISTER == regOpt)
          && ptr->db().is_cacheTemporaryObject(ptr.get())
         )
         {
             ptr.protect(true);
             ptr->checkIn();
         }
     }
     return ptr;
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const word& name,
     const tmp<GeometricField<Type, PatchField, GeoMesh>>& tfld,
     const wordList& patchFieldTypes,
     const wordList& actualPatchTypes
 )
 {
     return GeometricField<Type, PatchField, GeoMesh>::New
     (
         name,
         IOobjectOption::LEGACY_REGISTER,
         tfld,
         patchFieldTypes,
         actualPatchTypes
     );
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 template<class AnyType>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const GeometricField<AnyType, PatchField, GeoMesh>& fld,
     const word& name,
     const dimensionSet& dims,
     const word& patchFieldType
 )
 {
     auto ptr = tmp<GeometricField<Type, PatchField, GeoMesh>>::New
     (
         IOobject
         (
             name,
             fld.instance(),
             fld.db(),
             IOobjectOption::NO_READ,
             IOobjectOption::NO_WRITE,
             IOobjectOption::NO_REGISTER
         ),
         fld.mesh(),
         dims,
         patchFieldType
     );

     // Registration
     {
         if
         (
             // LEGACY_REGISTER: detect if caching is desired
             ptr->db().is_cacheTemporaryObject(ptr.get())
         )
         {
             ptr.protect(true);
             ptr->checkIn();
         }
     }
     return ptr;
 }


 template<class Type, template<class> class PatchField, class GeoMesh>
 template<class AnyType>
 Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh>>
 Foam::GeometricField<Type, PatchField, GeoMesh>::New
 (
     const GeometricField<AnyType, PatchField, GeoMesh>& fld,
     const word& name,
     const dimensioned<Type>& dt,
     const word& patchFieldType
 )
 {
     auto ptr = tmp<GeometricField<Type, PatchField, GeoMesh>>::New
     (
         IOobject
         (
             name,
             fld.instance(),
             fld.db(),
             IOobjectOption::NO_READ,
             IOobjectOption::NO_WRITE,
             IOobjectOption::NO_REGISTER
         ),
         fld.mesh(),
         dt.value(),
         dt.dimensions(),
         patchFieldType
     );

     // Registration
     {
         if
         (
             // LEGACY_REGISTER: detect if caching is desired
             ptr->db().is_cacheTemporaryObject(ptr.get())
         )
         {
             ptr.protect(true);
             ptr->checkIn();
         }
     }
     return ptr;
 }


 // ************************************************************************* //
Foam::dimensioned::value
const Type & value() const noexcept
Return const reference to value.
Definition: dimensionedType.H:366

Foam::List< word >

Foam::New
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tf1, const word &name, const dimensionSet &dimensions, const bool initCopy=false)
Global function forwards to reuseTmpDimensionedField::New.
Definition: DimensionedFieldReuseFunctions.H:124

Foam::GeometricField
Generic GeometricField class.
Definition: pointMVCWeight.H:58

Foam::dimensioned
Generic dimensioned Type class.
Definition: dimensionedScalarFwd.H:33

Foam::dimensionSet
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
Definition: dimensionSet.H:105

mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6

Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition: exprTraits.C:127

Foam::Field
Generic templated field type.
Definition: Field.H:62

Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:63

local
bool local
Definition: EEqn.H:20

Foam::dimensioned::dimensions
const dimensionSet & dimensions() const noexcept
Return const reference to dimensions.
Definition: dimensionedType.H:356

Foam::DimensionedField::Mesh
GeoMesh::Mesh Mesh
The mesh type for the DimensionedField.
Definition: DimensionedField.H:84

Foam::GeometricField::New
static tmp< GeometricField< Type, PatchField, GeoMesh > > New(const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensionSet &dims, const word &patchFieldType=PatchField< Type >::calculatedType())
Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions and patch type. [Takes current timeN...
Definition: GeometricFieldNew.C:77

fld
gmvFile<< "tracers "<< particles.size()<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().x()<< ' ';}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().y()<< ' ';}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().z()<< ' ';}gmvFile<< nl;for(const word &name :lagrangianScalarNames){ IOField< scalar > fld(IOobject(name, runTime.timeName(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
Definition: gmvOutputLagrangian.H:23

Foam::IOobjectOption::registerOption
registerOption
Enumeration for use with registerObject(). Values map to bool (false/true)
Definition: IOobjectOption.H:96

Foam::PtrList
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers...
Definition: List.H:55

Foam::GeoMesh
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:42

Foam::tmp
A class for managing temporary objects.
Definition: HashPtrTable.H:50

args
Foam::argList args(argc, argv)

Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition: IOobject.H:180