DOC: add deprecation notes for exprFixed/exprMixed BCs (#2703)

- this functionality can now be handled directly within
  uniformMixedFvPatchField etc, which are also more flexible.
This commit is contained in:
Mark Olesen
2023-06-14 09:47:01 +02:00
parent 9489a5a101
commit ffbd05f72a
7 changed files with 22 additions and 117 deletions

View File

@ -37,16 +37,17 @@ Usage
\endtable
Note
Can also just use uniformFixedValueFvPatchField with an expression
for the PatchFunction1.
This boundary condition is deprecated in favour of
Foam::uniformFixedValueFvPatchField
with expression entries.
SourceFiles
exprFixedValueFvPatchField.C
\*---------------------------------------------------------------------------*/
#ifndef exprFixedValueFvPatchField_H
#define exprFixedValueFvPatchField_H
#ifndef FoamDeprecated_exprFixedValueFvPatchField_H
#define FoamDeprecated_exprFixedValueFvPatchField_H
#include "fixedValueFvPatchField.H"
#include "patchExprFieldBase.H"

View File

@ -25,7 +25,8 @@ License
\*---------------------------------------------------------------------------*/
#include "exprFixedValueFvPatchFields.H"
#include "exprFixedValueFvPatchField.H"
#include "fieldTypes.H"
#include "volFields.H"
#include "addToRunTimeSelectionTable.H"
@ -36,6 +37,7 @@ namespace Foam
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
makePatchTypeFieldTypedefs(exprFixedValue);
makePatchFields(exprFixedValue);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

View File

@ -1,51 +0,0 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2019 OpenCFD Ltd.
-------------------------------------------------------------------------------
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/>.
\*---------------------------------------------------------------------------*/
#ifndef exprFixedValueFvPatchFields_H
#define exprFixedValueFvPatchFields_H
#include "exprFixedValueFvPatchField.H"
#include "fieldTypes.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
makePatchTypeFieldTypedefs(exprFixedValue);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //

View File

@ -109,6 +109,10 @@ Foam::exprMixedFvPatchField<Type>::exprMixedFvPatchField
),
driver_(this->patch(), dict_)
{
DeprecatedInFunction(2212)
<< "Use uniformMixed with Function1 expressions instead." << nl
<< " This boundary condition will be removed in the future" << endl;
setDebug();
DebugInFunction << nl;

View File

@ -38,21 +38,19 @@ Usage
\endtable
Note
For fixed-value boundary conditions, can also just use
uniformFixedValueFvPatchField with an expression for the
PatchFunction1, or a exprMixedFvPatchField.
For gradient boundary conditions, can also just use
uniformFixedGradientFvPatchField with an expression for the
PatchFunction1.
This boundary condition is deprecated in favour of
Foam::uniformMixedFvPatchField,
Foam::uniformFixedValueFvPatchField,
Foam::uniformFixedGradientFvPatchField
with expression entries.
SourceFiles
exprMixedFvPatchField.C
\*---------------------------------------------------------------------------*/
#ifndef exprMixedFvPatchField_H
#define exprMixedFvPatchField_H
#ifndef FoamDeprecated_exprMixedFvPatchField_H
#define FoamDeprecated_exprMixedFvPatchField_H
#include "mixedFvPatchField.H"
#include "patchExprFieldBase.H"

View File

@ -25,7 +25,8 @@ License
\*---------------------------------------------------------------------------*/
#include "exprMixedFvPatchFields.H"
#include "exprMixedFvPatchField.H"
#include "fieldTypes.H"
#include "volFields.H"
#include "addToRunTimeSelectionTable.H"
@ -36,6 +37,7 @@ namespace Foam
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
makePatchTypeFieldTypedefs(exprMixed);
makePatchFields(exprMixed);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

View File

@ -1,51 +0,0 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2019 OpenCFD Ltd.
-------------------------------------------------------------------------------
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/>.
\*---------------------------------------------------------------------------*/
#ifndef exprMixedFvPatchFields_H
#define exprMixedFvPatchFields_H
#include "exprMixedFvPatchField.H"
#include "fieldTypes.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
makePatchTypeFieldTypedefs(exprMixed);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //