waveMethod.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2017 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::waveMethod
28 
29 Description
30  Direct (one-to-one cell correspondence) mesh-to-mesh interpolation class
31 
32 SourceFiles
33  waveMethod.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef waveMethod_H
38 #define waveMethod_H
39 
40 #include "meshToMeshMethod.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class waveMethod Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class waveMethod
52 :
53  public meshToMeshMethod
54 {
55  // Private member functions
56 
57  //- No copy construct
58  waveMethod(const waveMethod&) = delete;
59 
60  //- No copy assignment
61  void operator=(const waveMethod&) = delete;
62 
63 
64 public:
65 
66  //- Run-time type information
67  TypeName("wave");
68 
69  //- Construct from source and target meshes
70  waveMethod(const polyMesh& src, const polyMesh& tgt);
71 
72  //- Destructor
73  virtual ~waveMethod();
74 
75 
76  // Member Functions
77 
78  // Evaluate
79 
80  //- Calculate addressing
81  static void calculate
82  (
83  const polyMesh& src,
84  const polyMesh& tgt,
85  labelList& srcToTgtAddr
86  );
87 
88  //- Calculate addressing and weights and optionally offset vectors
89  virtual void calculate
90  (
91  labelListList& srcToTgtAddr,
92  scalarListList& srcToTgtWght,
93  pointListList& srcToTgtVec,
94  labelListList& tgtToSrcAddr,
95  scalarListList& tgtToSrcWght,
96  pointListList& tgtToSrcVec
97  );
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
Foam::waveMethod::calculate
static void calculate(const polyMesh &src, const polyMesh &tgt, labelList &srcToTgtAddr)
Calculate addressing.
Definition: waveMethod.C:45
Foam::waveMethod::TypeName
TypeName("wave")
Run-time type information.
Foam::waveMethod
Direct (one-to-one cell correspondence) mesh-to-mesh interpolation class.
Definition: waveMethod.H:50
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:77
Foam::meshToMeshMethod
Base class for mesh-to-mesh calculation methods.
Definition: meshToMeshMethod.H:51
Foam::meshToMeshMethod::src
const polyMesh & src() const
Return const access to the source mesh.
Definition: meshToMeshMethodI.H:28
Foam::meshToMeshMethod::tgt
const polyMesh & tgt() const
Return const access to the target mesh.
Definition: meshToMeshMethodI.H:34
Foam::waveMethod::~waveMethod
virtual ~waveMethod()
Destructor.
Definition: waveMethod.C:171
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
meshToMeshMethod.H
Foam::List< label >