FreeFOAM The Cross-Platform CFD Toolkit
FieldMapper.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::FieldMapper
26 
27 Description
28  Abstract base class to hold the Field mapping addressing and weights.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef FieldMapper_H
33 #define FieldMapper_H
34 
35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
36 
37 namespace Foam
38 {
39 
40 /*---------------------------------------------------------------------------*\
41  Class FieldMapper Declaration
42 \*---------------------------------------------------------------------------*/
43 
45 {
46 
47 public:
48 
49  // Constructors
50 
51  //- Null constructor
53  {}
54 
55 
56  // Destructor
57 
58  virtual ~FieldMapper()
59  {}
60 
61 
62  // Member Functions
63 
64  virtual label size() const = 0;
65 
66  virtual bool direct() const = 0;
67 
68  virtual const unallocLabelList& directAddressing() const
69  {
70  FatalErrorIn("FieldMapper::directAddressing() const")
71  << "attempt to access null direct addressing"
72  << abort(FatalError);
73 
74  return unallocLabelList::null();
75  }
76 
77  virtual const labelListList& addressing() const
78  {
79  FatalErrorIn("FieldMapper::addressing() const")
80  << "attempt to access null interpolation addressing"
81  << abort(FatalError);
82 
83  return labelListList::null();
84  }
85 
86  virtual const scalarListList& weights() const
87  {
88  FatalErrorIn("FieldMapper::weights() const")
89  << "attempt to access null interpolation weights"
90  << abort(FatalError);
91 
92  return scalarListList::null();
93  }
94 
95 
96  // Member Operators
97 
98  template<class Type>
100  {
101  return tmp<Field<Type> >(new Field<Type>(f, *this));
102  }
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************ vim: set sw=4 sts=4 et: ************************ //