fvPatchFieldDoc.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) 2012 OpenFOAM Foundation
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 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
27 
28 \defgroup grpBoundaryConditions Boundary conditions
29 @{
30  This group contains OpenFOAM boundary condition types. All conditions
31  are derived from the base Foam::fvPatchField class. Patch values are
32  typically updated using the virtual functions
33  - Foam::fvPatchField::updateCoeffs()
34  - Foam::fvPatchField::evaluate()
35 
36  The difference between the methods is based on when the patch values are
37  updated. When the condition is applied to a solution variable, the
38  call to updateCoeffs() occurs as a preliminary step of the
39  <matrix>.solve(). The evaluate() method is invoked after, or independent
40  of the matrix solve, via a call to <field>.correctBoundaryConditions().
41 @}
42 
43 \defgroup grpConstraintBoundaryConditions Constraint
44 @{
45  \ingroup grpBoundaryConditions
46  This group contains constraint boundary condition types. These conditions
47  are mainly employed to reduced dimensioned cases.
48 @}
49 
50 \defgroup grpInletBoundaryConditions Inlet
51 @{
52  \ingroup grpBoundaryConditions
53  This group contains inlet boundary condition types
54 @}
55 
56 \defgroup grpOutletBoundaryConditions Outlet
57 @{
58  \ingroup grpBoundaryConditions
59  This group contains outlet boundary condition types
60 @}
61 
62 \defgroup grpGenericBoundaryConditions Generic
63 @{
64  \ingroup grpBoundaryConditions
65  This group contains generic boundary condition types
66 @}
67 
68 \defgroup grpCoupledBoundaryConditions Coupled
69 @{
70  \ingroup grpBoundaryConditions
71  This group contains coupled boundary condition types
72 @}
73 
74 \defgroup grpWallBoundaryConditions Wall
75 @{
76  \ingroup grpBoundaryConditions
77  This group contains wall boundary condition types
78 @}
79 
80 \*---------------------------------------------------------------------------*/