cyclicAMIPolyPatchI.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) 2011-2013 OpenFOAM Foundation
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 \*---------------------------------------------------------------------------*/
25 
26 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
27 
29 {
30  if (nbrPatchName_.empty())
31  {
32  // Try and use patchGroup to find samplePatch and sampleRegion
33  label patchID = coupleGroup_.findOtherPatchID(*this);
34 
35  nbrPatchName_ = boundaryMesh()[patchID].name();
36  }
37  return nbrPatchName_;
38 }
39 
40 
42 {
43  return rotationAxis_;
44 }
45 
46 
48 {
49  return rotationCentre_;
50 }
51 
52 
54 {
55  return separationVector_;
56 }
57 
58 
59 // ************************************************************************* //
const point & rotationCentre() const
Point on axis of rotation for rotational cyclic AMI.
vector separationVector_
Translation vector.
A class for handling words, derived from string.
Definition: word.H:59
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
const polyBoundaryMesh & boundaryMesh() const
Return boundaryMesh reference.
Definition: polyPatch.C:278
word nbrPatchName_
Name of other half.
point rotationCentre_
Point on axis of rotation for rotational cyclics.
const coupleGroupIdentifier coupleGroup_
Optional patchGroup to find neighbPatch.
const word & name() const
Return name.
Definition: IOobject.H:260
const vector & separationVector() const
Translation vector for translational cyclic AMI.
const vector & rotationAxis() const
Axis of rotation for rotational cyclic AMI.
vector rotationAxis_
Axis of rotation for rotational cyclics.
const word & neighbPatchName() const
Neighbour patch name.