adjointLbSolver.h

Go to the documentation of this file.

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2021 Julius Jessberger
 *  E-mail contact: info@openlb.net
 *  The most recent release of OpenLB can be downloaded at
 *  <http://www.openlb.net/>
 *
 *  This program 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 2
 *  of the License, or (at your option) any later version.
 *
 *  This program 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 this program; if not, write to the Free
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA  02110-1301, USA.
*/
 
 
#ifndef ADJOINT_LBSOLVER_H
#define ADJOINT_LBSOLVER_H
 
#include "functors/lattice/latticeFpop3D.h"
#include "solver/lbSolver.h"
 
 
namespace olb {
 
namespace opti {
 
enum class SolverMode : int {Reference, Primal, Dual};
 
template<
  typename T,
  typename PARAMETERS,
  typename LATTICES,
  SolverMode MODE
>
class AdjointLbSolver : virtual public LbSolver<T,PARAMETERS,LATTICES>
{
private:
  mutable OstreamManager            clout {std::cout, "AdjointLbSolver"};
 
public:
  using DESCRIPTOR = typename LATTICES::values_t::template get<0>;
 
  AdjointLbSolver() : AdjointLbSolver::LbSolver()
  { }
 
  AdjointLbSolver(utilities::TypeIndexedSharedPtrTuple<PARAMETERS> params)
   : AdjointLbSolver::LbSolver(params)
  { }
 
protected:
  // User needs to call this method for dual solver at the end of setInitialValues
  void loadPrimalPopulations()
  {
    const auto& params = this->parameters(names::Opti());
 
    this->lattice().template defineField<opti::F>(params.bulkIndicator, *params.fpop);
    this->lattice().template defineField<opti::DJDF>(params.objectiveDomain, *(params.dObjectiveDf));
 
    // update fields if gpu used
    this->lattice().template setProcessingContext<Array<opti::F>>(ProcessingContext::Simulation);
    this->lattice().template setProcessingContext<Array<opti::DJDF>>(ProcessingContext::Simulation);
  }
 
  // This method is called by default after simulation
  // If it gets overridden, the user needs to ensure that this method gets called
  virtual void computeResults() override
  {
    this->parameters(names::Results()).lattice = std::get<0>(this->_sLattices);
  }
};
 
}
 
}  // namespace olb
 
#endif