OpenLB 1.7
Loading...
Searching...
No Matches
setFreeEnergyOutletBoundary2D.hh
Go to the documentation of this file.
1/* This file is part of the OpenLB library
2 *
3 * Copyright (C) 2020 Alexander Schulz
4 * E-mail contact: info@openlb.net
5 * The most recent release of OpenLB can be downloaded at
6 * <http://www.openlb.net/>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public
19 * License along with this program; if not, write to the Free
20 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
22*/
23
24//This file contains the Free Energy Outlet Boundary
25//This is a new version of the Boundary, which only contains free floating functions
26#ifndef SET_FREE_ENERGY_OUTLET_BOUNDARY_2D_HH
27#define SET_FREE_ENERGY_OUTLET_BOUNDARY_2D_HH
28
30
31namespace olb {
32
35template<typename T, typename DESCRIPTOR, typename MixinDynamics>
37 SuperGeometry<T,2>& superGeometry, int material, std::string type, int latticeNumber)
38{
39 setFreeEnergyOutletBoundary<T,DESCRIPTOR, MixinDynamics>(sLattice, omega, superGeometry.getMaterialIndicator(material), type, latticeNumber);
40}
41
44template<typename T, typename DESCRIPTOR, typename MixinDynamics>
46 FunctorPtr<SuperIndicatorF2D<T>>&& indicator, std::string type, int latticeNumber)
47{
48 OstreamManager clout(std::cout, "setFreeEnergyOutletBoundary");
49 int _overlap = 1;
50 bool includeOuterCells = false;
51 if (indicator->getSuperGeometry().getOverlap() == 1) {
52 includeOuterCells = true;
53 clout << "WARNING: overlap == 1, boundary conditions set on overlap despite unknown neighbor materials" << std::endl;
54 }
55 for (int iCloc = 0; iCloc < sLattice.getLoadBalancer().size(); ++iCloc) {
56 setFreeEnergyOutletBoundary<T,DESCRIPTOR,MixinDynamics>(sLattice.getBlock(iCloc), omega,
57 indicator->getBlockIndicatorF(iCloc), type, latticeNumber, includeOuterCells);
58 }
60 addPoints2CommBC<T,DESCRIPTOR>(sLattice, std::forward<decltype(indicator)>(indicator), _overlap);
61}
62
64template<typename T, typename DESCRIPTOR, typename MixinDynamics>
65void setFreeEnergyOutletBoundary(BlockLattice<T,DESCRIPTOR>& block, T omega, BlockIndicatorF2D<T>& indicator, std::string type,
66 int latticeNumber, bool includeOuterCells)
67{
68 bool _output = false;
69 OstreamManager clout(std::cout, "setFreeEnergyOutletBoundary");
70 auto& blockGeometryStructure = indicator.getBlockGeometry();
71 const int margin = includeOuterCells ? 0 : 1;
72 //setFreeEnergyInletBoundary on the block domain
73 setFreeEnergyInletBoundary<T,DESCRIPTOR,MixinDynamics>(block, omega,
74 indicator, type, latticeNumber, includeOuterCells);
75 std::vector<int> discreteNormal(3, 0);
76 blockGeometryStructure.forSpatialLocations([&](auto iX, auto iY) {
77 if (blockGeometryStructure.getNeighborhoodRadius({iX, iY}) >= margin
78 && indicator(iX, iY)) {
79 discreteNormal = blockGeometryStructure.getStatistics().getType(iX,iY);
80 if (discreteNormal[0] == 0) {
81 block.addPostProcessor(
82 typeid(stage::PostStream), {iX, iY},
83 olb::boundaryhelper::promisePostProcessorForNormal<T,DESCRIPTOR, FreeEnergyConvectiveProcessor2D>(
84 Vector<int,2>(discreteNormal.data() + 1)));
85
86 if (_output) {
87 clout << "setFreeEnergyOutletBoundary<" << "," << ">(" << iX << ", "<< iY << ")" << std::endl;
88 }
89 }
90 }
91 });
92}
93
94
95}//namespace olb
96
97#endif
Base block indicator functor (discrete)
BlockGeometry< T, 2 > & getBlockGeometry()
Get underlying block geometry structure.
Platform-abstracted block lattice for external access and inter-block interaction.
virtual void addPostProcessor(std::type_index stage, LatticeR< DESCRIPTOR::d > latticeR, PostProcessorPromise< T, DESCRIPTOR > &&promise)=0
Schedule post processor for application to latticeR in stage.
Smart pointer for managing the various ways of passing functors around.
Definition functorPtr.h:60
class for marking output with some text
Representation of a statistic for a parallel 2D geometry.
std::unique_ptr< SuperIndicatorF< T, D > > getMaterialIndicator(std::vector< int > &&materials)
Returns a material indicator using the given vector of materials.
Super class maintaining block lattices for a cuboid decomposition.
BlockLattice< T, DESCRIPTOR > & getBlock(int locC)
Return BlockLattice with local index locC.
LoadBalancer< T > & getLoadBalancer()
Read and write access to the load balancer.
Plain old scalar vector.
Definition vector.h:47
Top level namespace for all of OpenLB.
void setFreeEnergyOutletBoundary(SuperLattice< T, DESCRIPTOR > &sLattice, T omega, SuperGeometry< T, 2 > &superGeometry, int material, std::string type, int latticeNumber)
Implementation of a outlet boundary condition for the partner lattices of the binary or ternary free ...
Communication after propagation.
Definition stages.h:36