mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
290 lines
8.2 KiB
C++
290 lines
8.2 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | www.openfoam.com
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
Copyright (C) 2011-2016 OpenFOAM Foundation
|
|
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/>.
|
|
|
|
Class
|
|
Foam::cyclicAMIFvPatchField
|
|
|
|
Group
|
|
grpCoupledBoundaryConditions
|
|
|
|
Description
|
|
This boundary condition enforces a cyclic condition between a pair of
|
|
boundaries, whereby communication between the patches is performed using
|
|
an arbitrary mesh interface (AMI) interpolation.
|
|
|
|
Usage
|
|
Example of the boundary condition specification:
|
|
\verbatim
|
|
<patchName>
|
|
{
|
|
type cyclicAMI;
|
|
}
|
|
\endverbatim
|
|
|
|
Note
|
|
The outer boundary of the patch pairs must be similar, i.e. if the owner
|
|
patch is transformed to the neighbour patch, the outer perimiter of each
|
|
patch should be identical (or very similar).
|
|
|
|
See also
|
|
Foam::AMIInterpolation
|
|
|
|
SourceFiles
|
|
cyclicAMIFvPatchField.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef cyclicAMIFvPatchField_H
|
|
#define cyclicAMIFvPatchField_H
|
|
|
|
|
|
#include "coupledFvPatchField.H"
|
|
#include "cyclicAMILduInterfaceField.H"
|
|
#include "cyclicAMIFvPatch.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class cyclicAMIFvPatchField Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class Type>
|
|
class cyclicAMIFvPatchField
|
|
:
|
|
virtual public cyclicAMILduInterfaceField,
|
|
public coupledFvPatchField<Type>
|
|
{
|
|
// Private data
|
|
|
|
//- Local reference cast into the cyclic patch
|
|
const cyclicAMIFvPatch& cyclicAMIPatch_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Return neighbour side field given internal fields
|
|
template<class Type2>
|
|
tmp<Field<Type2>> neighbourSideField
|
|
(
|
|
const Field<Type2>&
|
|
) const;
|
|
|
|
|
|
//- Return new matrix coeffs
|
|
tmp<Field<scalar>> coeffs
|
|
(
|
|
fvMatrix<Type>& matrix,
|
|
const Field<scalar>&,
|
|
const label
|
|
) const;
|
|
|
|
|
|
template<class Type2>
|
|
void collectStencilData
|
|
(
|
|
const refPtr<mapDistribute>& mapPtr,
|
|
const labelListList& stencil,
|
|
const Type2& data,
|
|
List<Type2>& expandedData
|
|
);
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName(cyclicAMIFvPatch::typeName_());
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from patch and internal field
|
|
cyclicAMIFvPatchField
|
|
(
|
|
const fvPatch&,
|
|
const DimensionedField<Type, volMesh>&
|
|
);
|
|
|
|
//- Construct from patch, internal field and dictionary
|
|
cyclicAMIFvPatchField
|
|
(
|
|
const fvPatch&,
|
|
const DimensionedField<Type, volMesh>&,
|
|
const dictionary&
|
|
);
|
|
|
|
//- Construct by mapping given cyclicAMIFvPatchField onto a new patch
|
|
cyclicAMIFvPatchField
|
|
(
|
|
const cyclicAMIFvPatchField<Type>&,
|
|
const fvPatch&,
|
|
const DimensionedField<Type, volMesh>&,
|
|
const fvPatchFieldMapper&
|
|
);
|
|
|
|
//- Construct as copy
|
|
cyclicAMIFvPatchField(const cyclicAMIFvPatchField<Type>&);
|
|
|
|
//- Construct and return a clone
|
|
virtual tmp<fvPatchField<Type>> clone() const
|
|
{
|
|
return tmp<fvPatchField<Type>>
|
|
(
|
|
new cyclicAMIFvPatchField<Type>(*this)
|
|
);
|
|
}
|
|
|
|
//- Construct as copy setting internal field reference
|
|
cyclicAMIFvPatchField
|
|
(
|
|
const cyclicAMIFvPatchField<Type>&,
|
|
const DimensionedField<Type, volMesh>&
|
|
);
|
|
|
|
//- Construct and return a clone setting internal field reference
|
|
virtual tmp<fvPatchField<Type>> clone
|
|
(
|
|
const DimensionedField<Type, volMesh>& iF
|
|
) const
|
|
{
|
|
return tmp<fvPatchField<Type>>
|
|
(
|
|
new cyclicAMIFvPatchField<Type>(*this, iF)
|
|
);
|
|
}
|
|
|
|
|
|
// Member functions
|
|
|
|
// Access
|
|
|
|
//- Return local reference cast into the cyclic AMI patch
|
|
const cyclicAMIFvPatch& cyclicAMIPatch() const
|
|
{
|
|
return cyclicAMIPatch_;
|
|
}
|
|
|
|
|
|
// Evaluation functions
|
|
|
|
//- Return true if coupled. Note that the underlying patch
|
|
// is not coupled() - the points don't align.
|
|
virtual bool coupled() const;
|
|
|
|
//- Return neighbour coupled internal cell data
|
|
virtual tmp<Field<Type>> patchNeighbourField() const;
|
|
|
|
//- Return reference to neighbour patchField
|
|
const cyclicAMIFvPatchField<Type>& neighbourPatchField() const;
|
|
|
|
//- Update result field based on interface functionality
|
|
virtual void updateInterfaceMatrix
|
|
(
|
|
solveScalarField& result,
|
|
const bool add,
|
|
const lduAddressing& lduAddr,
|
|
const label patchId,
|
|
const solveScalarField& psiInternal,
|
|
const scalarField& coeffs,
|
|
const direction cmpt,
|
|
const Pstream::commsTypes commsType
|
|
) const;
|
|
|
|
//- Update result field based on interface functionality
|
|
virtual void updateInterfaceMatrix
|
|
(
|
|
Field<Type>&,
|
|
const bool add,
|
|
const lduAddressing& lduAddr,
|
|
const label patchId,
|
|
const Field<Type>&,
|
|
const scalarField&,
|
|
const Pstream::commsTypes commsType
|
|
) const;
|
|
|
|
|
|
//- Manipulate matrix
|
|
virtual void manipulateMatrix
|
|
(
|
|
fvMatrix<Type>& m,
|
|
const label iMatrix,
|
|
const direction cmpt
|
|
);
|
|
|
|
|
|
// Cyclic AMI coupled interface functions
|
|
|
|
//- Does the patch field perform the transformation
|
|
virtual bool doTransform() const
|
|
{
|
|
return
|
|
!(cyclicAMIPatch_.parallel() || pTraits<Type>::rank == 0);
|
|
}
|
|
|
|
//- Return face transformation tensor
|
|
virtual const tensorField& forwardT() const
|
|
{
|
|
return cyclicAMIPatch_.forwardT();
|
|
}
|
|
|
|
//- Return neighbour-cell transformation tensor
|
|
virtual const tensorField& reverseT() const
|
|
{
|
|
return cyclicAMIPatch_.reverseT();
|
|
}
|
|
|
|
//- Return rank of component for transform
|
|
virtual int rank() const
|
|
{
|
|
return pTraits<Type>::rank;
|
|
}
|
|
|
|
|
|
// I-O
|
|
|
|
//- Write
|
|
virtual void write(Ostream& os) const;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#ifdef NoRepository
|
|
#include "cyclicAMIFvPatchField.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|