/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2016-2017 Wikki Ltd
Copyright (C) 2019-2022 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 .
Class
Foam::processorFaPatch
Description
Processor patch.
Author
Zeljko Tukovic, FMENA
Hrvoje Jasak, Wikki Ltd.
SourceFiles
processorFaPatch.C
\*---------------------------------------------------------------------------*/
#ifndef Foam_processorFaPatch_H
#define Foam_processorFaPatch_H
#include "coupledFaPatch.H"
#include "processorLduInterface.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class processorFaPatch Declaration
\*---------------------------------------------------------------------------*/
class processorFaPatch
:
public coupledFaPatch,
public processorLduInterface
{
// Private Data
//- My processor number
int myProcNo_;
//- Neighbour processor number
int neighbProcNo_;
//- Processor-neighbour patch edge centres
vectorField neighbEdgeCentres_;
//- Processor-neighbour patch edge lengths
vectorField neighbEdgeLengths_;
//- Processor-neighbour patch neighbour face centres
vectorField neighbEdgeFaceCentres_;
//- Corresponding neighbouring local point label for every local point
// (so localPoints()[i] == neighb.localPoints()[neighbPoints_[i]])
mutable autoPtr neighbPointsPtr_;
//- The set of labels of the processor patch points which are
// non-global, i.e. present in this processor patch
mutable autoPtr nonGlobalPatchPointsPtr_;
protected:
// Protected Member functions
//- Construct from components with specified name
processorFaPatch
(
const word& name,
const labelUList& edgeLabels,
const label index,
const faBoundaryMesh& bm,
const label nbrPolyPatchi,
const label myProcNo,
const label neighbProcNo,
const word& patchType = typeName
);
//- Make patch weighting factors
void makeWeights(scalarField&) const;
//- Make patch geodesic distance between P and N
void makeLPN(scalarField&) const;
//- Make patch face - neighbour cell distances
void makeDeltaCoeffs(scalarField&) const;
//- Make non-orthogonality correction vectors
void makeCorrectionVectors(vectorField&) const;
//- Find non-globa patch points
void makeNonGlobalPatchPoints() const;
// Geometry Functions
//- Initialise the calculation of the patch geometry
void initGeometry(PstreamBuffers&);
//- Calculate the patch geometry
void calcGeometry(PstreamBuffers&);
//- Initialise the patches for moving points
void initMovePoints(PstreamBuffers&, const pointField&);
//- Correct patches after moving points
void movePoints(PstreamBuffers&, const pointField&);
//- Initialise the update of the patch topology
virtual void initUpdateMesh(PstreamBuffers&);
//- Update of the patch topology
virtual void updateMesh(PstreamBuffers&);
public:
//- Runtime type information
TypeName("processor");
// Constructors
//- Construct from components with automatically generated standard name
processorFaPatch
(
const labelUList& edgeLabels,
const label index,
const faBoundaryMesh& bm,
const label nbrPolyPatchi,
const label myProcNo,
const label neighbProcNo,
const word& patchType = typeName
);
//- Construct from dictionary
processorFaPatch
(
const word& name,
const dictionary& dict,
const label index,
const faBoundaryMesh& bm,
const word& patchType = typeName
);
//- Destructor
virtual ~processorFaPatch();
// Member Functions
//- Return interface size
virtual label interfaceSize() const noexcept
{
return size();
}
//- Return processor number
int myProcNo() const noexcept
{
return myProcNo_;
}
//- Return neighbour processor number
int neighbProcNo() const noexcept
{
return neighbProcNo_;
}
//- Return true if running parallel
virtual bool coupled() const
{
return UPstream::parRun();
}
//- Does this side own the patch ?
virtual bool owner() const noexcept
{
return (myProcNo_ < neighbProcNo_);
}
//- The message tag to use for communication
virtual int tag() const
{
return UPstream::msgType();
}
//- Return communicator used for communication
virtual label comm() const;
//- Return face transformation tensor
virtual const tensorField& forwardT() const
{
return coupledFaPatch::forwardT();
}
//- Return delta (P to N) vectors across coupled patch
virtual tmp delta() const;
//- Return processor-neighbour patch edge centres
const vectorField& neighbEdgeCentres() const noexcept
{
return neighbEdgeCentres_;
}
//- Return processor-neighbour patch edge lengths
const vectorField& neighbEdgeLengths() const noexcept
{
return neighbEdgeLengths_;
}
//- Return processor-neighbour patch edge unit normals
tmp neighbEdgeNormals() const;
//- Return processor-neighbour patch neighbour face centres
const vectorField& neighbEdgeFaceCentres() const noexcept
{
return neighbEdgeFaceCentres_;
}
//- Return neighbour point labels. This is for my local point the
// corresponding local point on the other side. Call
// faBoundaryMesh::updateMesh() on all processors
// before using this.
const labelList& neighbPoints() const;
//- Return the set of labels of the processor patch points which are
// non-global, i.e. present in this processorFaPatch
const labelList& nonGlobalPatchPoints() const;
// Interface transfer functions
//- Return the values of the given internal data adjacent to
//- the interface as a field
virtual tmp interfaceInternalField
(
const labelUList& internalData
) const;
//- Return the values of the given internal data adjacent to
//- the interface as a field using edgeFaces
virtual tmp interfaceInternalField
(
const labelUList& internalData,
const labelUList& edgeFaces
) const;
//- Initialise interface data transfer
virtual void initTransfer
(
const Pstream::commsTypes commsType,
const labelUList& interfaceData
) const;
//- Transfer and return neighbour field
virtual tmp transfer
(
const Pstream::commsTypes commsType,
const labelUList& interfaceData
) const;
//- Initialise neighbour field transfer
virtual void initInternalFieldTransfer
(
const Pstream::commsTypes commsType,
const labelUList& internalData
) const;
//- Return neighbour field
virtual tmp internalFieldTransfer
(
const Pstream::commsTypes commsType,
const labelUList& internalData
) const;
//- Return neighbour field using mapping
virtual tmp internalFieldTransfer
(
const Pstream::commsTypes commsType,
const labelUList& internalData,
const labelUList& edgeCells
) const;
//- Write the patch data as a dictionary
virtual void write(Ostream& os) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //