File size: 4,221 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2015-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::gradingDescriptor
Description
Handles the specification for grading within a section of a block
blockFraction: the fraction of the block the section occupies
nDivFraction: the fraction of the divisions of the block allocated to
the section
expansionRatio: the expansions ratio for the grading with the section of
block defined as the ratio of the size of the division at either and
of the section.
SourceFiles
gradingDescriptor.C
\*---------------------------------------------------------------------------*/
#ifndef gradingDescriptor_H
#define gradingDescriptor_H
#include "scalar.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class Istream;
class Ostream;
// Forward declaration of friend functions and operators
class gradingDescriptor;
class gradingDescriptors;
Istream& operator>>(Istream&, gradingDescriptor&);
Ostream& operator<<(Ostream&, const gradingDescriptor&);
/*---------------------------------------------------------------------------*\
Class gradingDescriptor Declaration
\*---------------------------------------------------------------------------*/
class gradingDescriptor
{
// Private Data
scalar blockFraction_;
scalar nDivFraction_;
scalar expansionRatio_;
public:
friend class gradingDescriptors;
// Constructors
//- Default constructor
gradingDescriptor();
//- Construct from components
gradingDescriptor
(
const scalar blockFraction,
const scalar nDivFraction,
const scalar expansionRatio
);
//- Construct from expansionRatio
gradingDescriptor
(
const scalar expansionRatio
);
//- Construct from Istream
gradingDescriptor(Istream&);
//- Destructor
~gradingDescriptor();
// Member Functions
// Access
scalar blockFraction() const
{
return blockFraction_;
}
scalar nDivFraction() const
{
return nDivFraction_;
}
scalar expansionRatio() const
{
return expansionRatio_;
}
// Member Functions
//- Return the inverse gradingDescriptor with 1/expansionRatio
gradingDescriptor inv() const;
// Member Operators
bool operator==(const gradingDescriptor&) const;
bool operator!=(const gradingDescriptor&) const;
// IOstream Operators
friend Istream& operator>>(Istream&, gradingDescriptor&);
friend Ostream& operator<<(Ostream&, const gradingDescriptor&);
friend Istream& operator>>(Istream&, gradingDescriptors&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|