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