src/foam/db/IOobjects/IOReferencer/IOReferencer.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::IOReferencer
  26
  27 Description
  28     A wrapper class that allows you to retrieve non-IOobjects through the
  29     object registry.  Performs no input or output, simply for a const reference
  30     retrieval.
  31
  32     Syntax:
  33     @verbatim
  34         // Your non-IOobject, e.g. Type = scalar
  35         Type myObject;
  36
  37         // Register it to the object registry
  38         IOReferencer<scalar> myIOobject
  39         (
  40             IOobject
  41             (
  42                 "lookupName",
  43                 instance,           // can be anything
  44                 [local,]            // (optional) can be anything
  45                 registry,           // can be anything
  46                 IOobject::NO_READ,  // *must* be NO_READ
  47                 IOobject::NO_WRITE  // *must* be NO_WRITE
  48             ),
  49             myObject
  50         );
  51
  52         // (Now don't let myObject and myIOobject go out of scope)
  53
  54         // In another part of your solver, e.g. in a custom boundary condition:
  55         const Type& myConstObject = registry.lookupObject<IOReferencer<Type> >
  56         (
  57             "lookupName"
  58         )();
  59
  60         // Now you have a local const reference to your non-IOobject
  61     @endverbatim
  62
  63 SourceFiles
  64     IOReferencer.C
  65
  66 Author
  67     David L. F. Gaden
  68
  69 \*---------------------------------------------------------------------------*/
  70
  71 #ifndef IOReferencer_H
  72 #define IOReferencer_H
  73
  74 #include "regIOobject.H"
  75
  76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  77
  78 namespace Foam
  79 {
  80
  81
  82 /*---------------------------------------------------------------------------*\
  83                            Class IOReferencer Declaration
  84 \*---------------------------------------------------------------------------*/
  85
  86 template<class Type>
  87 class IOReferencer
  88 :
  89     public regIOobject
  90 {
  91
  92     const Type * typePtr_;
  93
  94 public:
  95
  96     // Constructors
  97
  98         //- Construct from IOobject - pointer set to null
  99         IOReferencer
 100         (
 101             const IOobject& io
 102         );
 103
 104         //- Construct from IOobject - pointer initialized
 105         IOReferencer
 106         (
 107             const IOobject& io,
 108             const Type& reference
 109         );
 110
 111
 112     // Destructor
 113
 114         virtual ~IOReferencer();
 115
 116
 117     // Member functions
 118
 119         //- A "do nothing" writeData function, required by regIOobject
 120         virtual bool writeData(Ostream&) const;
 121
 122         //- Return the pointer as a reference
 123         const Type& operator()() const;
 124
 125         //- Set the pointer
 126         void set(const Type& reference);
 127
 128 };
 129
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 } // End namespace Foam
 134
 135 #ifdef NoRepository
 136 #   include "IOReferencer.C"
 137 #endif
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 #endif
 142
 143 // ************************************************************************* //