This class implements the evaluation of the goal functional and its derivatives by using adjoint LBM. More...

#include <optiCaseDual.h>

Inheritance diagram for olb::opti::OptiCaseDual< S, SOLVER, C >:

Collaboration diagram for olb::opti::OptiCaseDual< S, SOLVER, C >:

Public Member Functions
	OptiCaseDual (XMLreader const &xml)

	~OptiCaseDual ()

void	free ()

S	evaluateObjective (const C &control, unsigned optiStep=0) override
	Solve primal problem and evaluate objective.

void	computeDerivatives (const C &control, C &derivatives, unsigned optiStep=0) override
	Compute derivatives via adjoint problem.

C	getReferenceControl () const

Public Member Functions inherited from olb::opti::OptiCase< S, C >
	OptiCase ()=default

	OptiCase (std::function< void(void)> postEvaluation)

void	postEvaluation ()

Public Attributes
bool	_verbose {true}

std::size_t	_dimCtrl
	upper limit for the number of control variables (#voxels * field-dimension)

ControlType	_controlType
	Either force or porosity field.

StartValueType	_startValueType {Control}

std::string	_projectionName

int	_fieldDim
	Spatial dimension of controlled field.

int	_controlMaterial
	Material number of design domain.

S	_regAlpha {0}
	Regulatory term in objective functional (so far unused)

Controller< S > *	_controller {nullptr}
	Manages the array of control variables.

UnitConverter< S, descriptor > *	_converter {nullptr}

std::shared_ptr< SOLVER< S, SolverMode::Primal > >	_primalSolver

std::shared_ptr< SOLVER< S, SolverMode::Dual > >	_dualSolver

std::shared_ptr< SOLVER< S, SolverMode::Reference > >	_referenceSolver

bool	_computeReference {false}

std::shared_ptr< SuperGeometry< S, dim > >	_referenceGeometry

std::shared_ptr< SuperLattice< S, descriptor > >	_referenceLattice

std::shared_ptr< GeometrySerializer< S, dim > >	_serializer

std::shared_ptr< projection::Base< S > >	_projection

std::shared_ptr< SuperLatticeF< S, descriptor > >	_projectedControl
	maps the control to a lattice functor

std::shared_ptr< SuperLatticeF< S, descriptor > >	_dProjectionDcontrol
	derivative of _projectionControl

Additional Inherited Members
Protected Attributes inherited from olb::opti::OptiCase< S, C >
std::function< void(void)>	_postEvaluation { [](){} }

Detailed Description

template<typename S, template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>
class olb::opti::OptiCaseDual< S, SOLVER, C >

This class implements the evaluation of the goal functional and its derivatives by using adjoint LBM.

The adjoint equations are problem-specific and have been computed for force and porosity optimization so far.

Requirements: S is the arithmetic data type SOLVER implements the (primal/ dual) simulation, inherits from AdjointLbSolverBase An xml file is expected to provide additional information on e.g. simulation and optimization parameters

Definition at line 60 of file optiCaseDual.h.

Constructor & Destructor Documentation

◆ OptiCaseDual()

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

olb::opti::OptiCaseDual< S, SOLVER, C >::OptiCaseDual ( XMLreader const & xml )

inline

Definition at line 102 of file optiCaseDual.h.

                                     {
    readFromXML(xml);
    initialize(xml);
    initializeFields();
  }

◆ ~OptiCaseDual()

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

olb::opti::OptiCaseDual< S, SOLVER, C >::~OptiCaseDual ( )

inline

Definition at line 108 of file optiCaseDual.h.

                  {
    free();
  }

References olb::opti::OptiCaseDual< S, SOLVER, C >::free().

Here is the call graph for this function:

Member Function Documentation

◆ computeDerivatives()

template<typename S , template< typename, SolverMode > typename SOLVER, typename C >

void olb::opti::OptiCaseDual< S, SOLVER, C >::computeDerivatives	(	const C &	control,
		C &	derivatives,
		unsigned	optiStep = 0 )

overridevirtual

Compute derivatives via adjoint problem.

Implements olb::opti::OptiCase< S, C >.

Definition at line 177 of file optiCaseDual.hh.

{
  _controller->setControl(control, _dimCtrl);
  _dualSolver->parameters(names::OutputOpti()).counterOptiStep = optiStep;
 
  const auto& primalResults = _primalSolver->parameters(names::Results());
  auto& dualParams = _dualSolver->parameters(names::Opti());
 
  dualParams.fpop = primalResults.fpop;
  dualParams.dObjectiveDf = primalResults.djdf;
  dualParams.dObjectiveDcontrol = primalResults.djdalpha;
 
  _dualSolver->solve();
 
  derivativesFromDualSolution(derivatives);
}

References olb::opti::control.

◆ evaluateObjective()

template<typename S , template< typename, SolverMode > typename SOLVER, typename C >

S olb::opti::OptiCaseDual< S, SOLVER, C >::evaluateObjective	(	const C &	control,
		unsigned	optiStep = 0 )

overridevirtual

Solve primal problem and evaluate objective.

Implements olb::opti::OptiCase< S, C >.

Definition at line 120 of file optiCaseDual.hh.

{
  //project control to enforce volume constraint
#ifdef mathiasProjection
 
  const int nx = _dualSolver->getGeometry()->getCuboidGeometry().getMotherCuboid().getNx();
  const int ny = _dualSolver->getGeometry()->getCuboidGeometry().getMotherCuboid().getNy();
  const int nz = _dualSolver->getGeometry()->getCuboidGeometry().getMotherCuboid().getNz();
 
  S pi = 4.0 * util::atan(1.0);
 
  S totalD = T();
  S wantedTotalD = T();
 
  S upperBound, lowerBound, volumeRatio;
  xml.readOrWarn<T>("Optimization", "UpperBound", "", upperBound);
  xml.readOrWarn<T>("Optimization", "LowerBound", "", lowerBound);
  xml.readOrWarn<T>("Optimization", "VolumeRatio", "", volumeRatio);
 
  for (int iX=1; iX<nx-1; iX++) {
    for (int iY=1; iY<ny-1; iY++) {
      for (int iZ=1; iZ<nz-1; iZ++) {
        // TODO: this seems to be fixed to material number = 6
        if (_dualSolver->getGeometry()->getMaterial(iX,iY,iZ)==6) {
          S ctrl = control[(iX-1)*(ny-1)*(nz-1)+(iY-1)*(nz-1)+(iZ-1)];
          totalD += 1./(upperBound-lowerBound)*(ctrl-1.);
          wantedTotalD += 1.0;
        }
      }
    }
  }
 
  for (int iX=1; iX<nx-1; iX++) {
    for (int iY=1; iY<ny-1; iY++) {
      for (int iZ=1; iZ<nz-1; iZ++) {
        // TODO: this seems to be fixed to material number = 6
        if (_dualSolver->getGeometry()->getMaterial(iX,iY,iZ)==6) {
          control[(iX-1)*(ny-1)*(nz-1)+(iY-1)*(nz-1)+(iZ-1)]
           = lowerBound
             + (control[(iX-1)*(ny-1)*(nz-1)+(iY-1)*(nz-1)+(iZ-1)] - lowerBound)
               * wantedTotalD * (1.-volumeRatio) / totalD;
        }
      }
    }
  }
#endif
 
  _controller->setControl(control, _dimCtrl);
  _primalSolver->parameters(names::OutputOpti()).counterOptiStep = optiStep;
  _primalSolver->solve();
 
  return _primalSolver->parameters(names::Results()).objective;
}

References olb::util::atan(), and olb::opti::control.

Here is the call graph for this function:

◆ free()

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

void olb::opti::OptiCaseDual< S, SOLVER, C >::free ( )

inline

Definition at line 112 of file optiCaseDual.h.

              {
    delete _converter;
    _converter = nullptr;
    delete _controller;
    _controller = nullptr;
  }

References olb::opti::OptiCaseDual< S, SOLVER, C >::_controller, and olb::opti::OptiCaseDual< S, SOLVER, C >::_converter.

Here is the caller graph for this function:

◆ getReferenceControl()

template<typename S , template< typename, SolverMode > typename SOLVER, typename C >

C olb::opti::OptiCaseDual< S, SOLVER, C >::getReferenceControl ( ) const

Definition at line 269 of file optiCaseDual.hh.

{
  assert((this->_computeReference) && "Reference solution has not yet been computed\n");
  C result = util::ContainerCreator<C>::create(_dimCtrl);
 
  if (_controlType == ForceControl) {
      LatticeR<dim+1> latticeR;
      for (int iC=0; iC<_referenceGeometry->getCuboidGeometry().getNc(); iC++) {
      latticeR[0] = iC;
      int nX = _referenceGeometry->getCuboidGeometry().get(iC).getNx();
      int nY = _referenceGeometry->getCuboidGeometry().get(iC).getNy();
      int nZ = _referenceGeometry->getCuboidGeometry().get(iC).getNz();
      for (int iX=0; iX<nX; iX++) {
        latticeR[1] = iX;
        for (int iY=0; iY<nY; iY++) {
          latticeR[2] = iY;
          for (int iZ=0; iZ<nZ; iZ++) {
            latticeR[3] = iZ;
 
            if (getMaterialGlobally(*_referenceGeometry, latticeR) == _controlMaterial) {
              C force_help(_fieldDim, 0);
              if (_referenceGeometry->getLoadBalancer().rank(iC)  == singleton::mpi().getRank()) {
                for (int iDim=0; iDim<_fieldDim; iDim++) {
                  const auto cell = _referenceLattice->get(latticeR);
                  force_help[iDim]
                   = _projection->inverse(cell.template getFieldComponent<descriptors::FORCE>(iDim));
                }
              }
#ifdef PARALLEL_MODE_MPI
              singleton::mpi().bCast(&force_help[0], _fieldDim, _referenceGeometry->getLoadBalancer().rank(iC));
#endif
              for (int iDim=0; iDim<_fieldDim; iDim++) {
                const int index = _serializer->getSerializedComponentIndex(latticeR, iDim, _fieldDim);
                result[index] = force_help[iDim];
              }
            }
          }
        }
      }
    }
  } else {
    clout << "getReferenceControl() is only implemented for forced optimization" << std::endl;
    exit(1);
  }
  return result;
}

References olb::singleton::MpiManager::bCast(), olb::opti::ForceControl, olb::opti::getMaterialGlobally(), olb::singleton::MpiManager::getRank(), and olb::singleton::mpi().

Here is the call graph for this function:

Member Data Documentation

◆ _computeReference

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

bool olb::opti::OptiCaseDual< S, SOLVER, C >::_computeReference {false}

Definition at line 91 of file optiCaseDual.h.

91{false};

◆ _controller

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

Controller<S>* olb::opti::OptiCaseDual< S, SOLVER, C >::_controller {nullptr}

Manages the array of control variables.

Definition at line 85 of file optiCaseDual.h.

85{nullptr};

◆ _controlMaterial

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

int olb::opti::OptiCaseDual< S, SOLVER, C >::_controlMaterial

Material number of design domain.

Definition at line 80 of file optiCaseDual.h.

◆ _controlType

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

ControlType olb::opti::OptiCaseDual< S, SOLVER, C >::_controlType

Either force or porosity field.

Definition at line 73 of file optiCaseDual.h.

◆ _converter

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

UnitConverter<S,descriptor>* olb::opti::OptiCaseDual< S, SOLVER, C >::_converter {nullptr}

Definition at line 86 of file optiCaseDual.h.

86{nullptr};

◆ _dimCtrl

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

std::size_t olb::opti::OptiCaseDual< S, SOLVER, C >::_dimCtrl

upper limit for the number of control variables (#voxels * field-dimension)

Definition at line 70 of file optiCaseDual.h.

◆ _dProjectionDcontrol

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

std::shared_ptr<SuperLatticeF<S,descriptor> > olb::opti::OptiCaseDual< S, SOLVER, C >::_dProjectionDcontrol

derivative of _projectionControl

Definition at line 100 of file optiCaseDual.h.

◆ _dualSolver

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

std::shared_ptr<SOLVER<S,SolverMode::Dual> > olb::opti::OptiCaseDual< S, SOLVER, C >::_dualSolver

Definition at line 88 of file optiCaseDual.h.

◆ _fieldDim

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

int olb::opti::OptiCaseDual< S, SOLVER, C >::_fieldDim

Spatial dimension of controlled field.

Definition at line 78 of file optiCaseDual.h.

◆ _primalSolver

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

std::shared_ptr<SOLVER<S,SolverMode::Primal> > olb::opti::OptiCaseDual< S, SOLVER, C >::_primalSolver

Definition at line 87 of file optiCaseDual.h.

◆ _projectedControl

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

std::shared_ptr<SuperLatticeF<S,descriptor> > olb::opti::OptiCaseDual< S, SOLVER, C >::_projectedControl

maps the control to a lattice functor

Definition at line 98 of file optiCaseDual.h.

◆ _projection

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

std::shared_ptr<projection::Base<S> > olb::opti::OptiCaseDual< S, SOLVER, C >::_projection

Definition at line 96 of file optiCaseDual.h.

◆ _projectionName

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

std::string olb::opti::OptiCaseDual< S, SOLVER, C >::_projectionName

Definition at line 75 of file optiCaseDual.h.

◆ _referenceGeometry

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

std::shared_ptr<SuperGeometry<S,dim> > olb::opti::OptiCaseDual< S, SOLVER, C >::_referenceGeometry

Definition at line 92 of file optiCaseDual.h.

◆ _referenceLattice

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

std::shared_ptr<SuperLattice<S,descriptor> > olb::opti::OptiCaseDual< S, SOLVER, C >::_referenceLattice

Definition at line 93 of file optiCaseDual.h.

◆ _referenceSolver

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

std::shared_ptr<SOLVER<S,SolverMode::Reference> > olb::opti::OptiCaseDual< S, SOLVER, C >::_referenceSolver

Definition at line 89 of file optiCaseDual.h.

◆ _regAlpha

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

S olb::opti::OptiCaseDual< S, SOLVER, C >::_regAlpha {0}

Regulatory term in objective functional (so far unused)

Definition at line 82 of file optiCaseDual.h.

82{0};

◆ _serializer

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

std::shared_ptr<GeometrySerializer<S,dim> > olb::opti::OptiCaseDual< S, SOLVER, C >::_serializer

Definition at line 95 of file optiCaseDual.h.

◆ _startValueType

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

StartValueType olb::opti::OptiCaseDual< S, SOLVER, C >::_startValueType {Control}

Definition at line 74 of file optiCaseDual.h.

74{Control};

olb::opti::Control

@ Control

Definition projection.h:42

◆ _verbose

template<typename S , template< typename, SolverMode > typename SOLVER, typename C = std::vector<S>>

bool olb::opti::OptiCaseDual< S, SOLVER, C >::_verbose {true}

Definition at line 68 of file optiCaseDual.h.

68{true};

The documentation for this class was generated from the following files:

src/optimization/optiCaseDual.h
src/optimization/optiCaseDual.hh

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OptiCaseDual()

◆ ~OptiCaseDual()

Member Function Documentation

◆ computeDerivatives()

◆ evaluateObjective()

◆ free()

◆ getReferenceControl()

Member Data Documentation

◆ _computeReference

◆ _controller

◆ _controlMaterial

◆ _controlType

◆ _converter

◆ _dimCtrl

◆ _dProjectionDcontrol

◆ _dualSolver

◆ _fieldDim

◆ _primalSolver

◆ _projectedControl

◆ _projection

◆ _projectionName

◆ _referenceGeometry

◆ _referenceLattice

◆ _referenceSolver

◆ _regAlpha

◆ _serializer

◆ _startValueType

◆ _verbose