Transferred copyright to the OpenFOAM Foundation
[OpenFOAM-2.0.x.git] / src / OpenFOAM / meshes / polyMesh / zones / cellZone / cellZone.C
bloba408ec87a77b5a62fb86bfac84b3d640369fda72
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 \*---------------------------------------------------------------------------*/
26 #include "cellZone.H"
27 #include "addToRunTimeSelectionTable.H"
28 #include "cellZoneMesh.H"
29 #include "polyMesh.H"
30 #include "primitiveMesh.H"
31 #include "IOstream.H"
32 #include "demandDrivenData.H"
34 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
36 namespace Foam
38     defineTypeNameAndDebug(cellZone, 0);
39     defineRunTimeSelectionTable(cellZone, dictionary);
40     addToRunTimeSelectionTable(cellZone, cellZone, dictionary);
43 const char * const Foam::cellZone::labelsName = "cellLabels";
45 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
47 Foam::cellZone::cellZone
49     const word& name,
50     const labelUList& addr,
51     const label index,
52     const cellZoneMesh& zm
55     zone(name, addr, index),
56     zoneMesh_(zm)
60 Foam::cellZone::cellZone
62     const word& name,
63     const Xfer<labelList>& addr,
64     const label index,
65     const cellZoneMesh& zm
68     zone(name, addr, index),
69     zoneMesh_(zm)
73 Foam::cellZone::cellZone
75     const word& name,
76     const dictionary& dict,
77     const label index,
78     const cellZoneMesh& zm
81     zone(name, dict, this->labelsName, index),
82     zoneMesh_(zm)
86 Foam::cellZone::cellZone
88     const cellZone& cz,
89     const labelUList& addr,
90     const label index,
91     const cellZoneMesh& zm
94     zone(cz, addr, index),
95     zoneMesh_(zm)
98 Foam::cellZone::cellZone
100     const cellZone& cz,
101     const Xfer<labelList>& addr,
102     const label index,
103     const cellZoneMesh& zm
106     zone(cz, addr, index),
107     zoneMesh_(zm)
111 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
113 Foam::cellZone::~cellZone()
117 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
119 Foam::label Foam::cellZone::whichCell(const label globalCellID) const
121     return zone::localID(globalCellID);
125 const Foam::cellZoneMesh& Foam::cellZone::zoneMesh() const
127     return zoneMesh_;
131 bool Foam::cellZone::checkDefinition(const bool report) const
133     return zone::checkDefinition(zoneMesh_.mesh().nCells(), report);
137 void Foam::cellZone::writeDict(Ostream& os) const
139     os  << nl << name() << nl << token::BEGIN_BLOCK << nl
140         << "    type " << type() << token::END_STATEMENT << nl;
142     writeEntry(this->labelsName, os);
144     os  << token::END_BLOCK << endl;
148 // * * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * //
150 void Foam::cellZone::operator=(const cellZone& zn)
152     clearAddressing();
153     labelList::operator=(zn);
157 void Foam::cellZone::operator=(const labelUList& addr)
159     clearAddressing();
160     labelList::operator=(addr);
164 void Foam::cellZone::operator=(const Xfer<labelList>& addr)
166     clearAddressing();
167     labelList::operator=(addr);
171 // * * * * * * * * * * * * * * * Ostream Operator  * * * * * * * * * * * * * //
173 Foam::Ostream& Foam::operator<<(Ostream& os, const cellZone& zn)
175     zn.write(os);
176     os.check("Ostream& operator<<(Ostream&, const cellZone&");
177     return os;
181 // ************************************************************************* //