olb::opti::projection Namespace Reference

Classes
struct	Baron
struct	Base
struct	Foerster
struct	FoersterN
	FoersterProjection for arbitrary n. More...
struct	ForceFactor
	Convert force to lattice units. More...
struct	GiBase
	Gridterm-dependent projection base class. More...
struct	Identity
struct	Krause
struct	Rectifier
struct	Sigmoid
struct	Softplus
struct	StasiusN
	StasiusProjection for arbitrary n. More...

Functions
template<typename T , typename DESCRIPTOR >
T	gridTerm (const UnitConverter< T, DESCRIPTOR > &converter)
template<typename T >
T	porosityToControl (T porosity, const Base< T > &projection)
	Get control value for given porosity.
template<typename T , typename DESCRIPTOR >
T	permeabilityToPorosity (T permeability, const UnitConverter< T, DESCRIPTOR > &converter)
	Get porosity for given permeability.
template<typename T , typename DESCRIPTOR >
T	permeabilityToControl (T permeability, const Base< T > &projection, const UnitConverter< T, DESCRIPTOR > &converter)
	Get control for given permeability.
template<typename T , typename DESCRIPTOR >
T	getInitialControl (T startValue, const Base< T > &projection, const UnitConverter< T, DESCRIPTOR > &converter, StartValueType type, bool verbose=true)
	Transform porosity/ permeability/ other startValue into control.
template<typename T , typename OptiCaseDual_Type >
T	getInitialControl (T startValue, OptiCaseDual_Type &optiCase)
template<typename T , typename DESCRIPTOR >
std::shared_ptr< projection::Base< T > >	construct (const UnitConverter< T, DESCRIPTOR > &converter, std::string &name)

Function Documentation

construct()

template<typename T , typename DESCRIPTOR >

std::shared_ptr< projection::Base< T > > olb::opti::projection::construct	(	const UnitConverter< T, DESCRIPTOR > &	converter,
		std::string &	name )

Definition at line 320 of file projection.h.

{
  std::smatch match;
  if (name == "Identity") {
    return std::make_shared<Identity<T>>();
  } else if (name == "Sigmoid") {
    return std::make_shared<Sigmoid<T>>();
  } else if (name == "ForceFactor") {
    return std::make_shared<ForceFactor<T>>(converter);
  } else if (name == "Rectifier") {
    return std::make_shared<Rectifier<T>>();
  } else if (name == "Softplus") {
    return std::make_shared<Softplus<T>>();
  } else if (name == "Baron") {
    return std::make_shared<Baron<T>>();
  } else if (name == "Krause") {
    return std::make_shared<Krause<T>>();
  } else if (name == "Foerster") {
    return std::make_shared<Foerster<T,DESCRIPTOR>>(converter);
  } else if (std::regex_match(name, match, std::regex ("(Foerster)([0-9])"))) {
    const unsigned n = std::stoi(match[2]);
    return std::make_shared<FoersterN<T,DESCRIPTOR>>(converter, n);
  } else if (std::regex_match(name, match, std::regex ("(Stasius)([0-9])"))) {
    const unsigned n = std::stoi(match[2]);
    return std::make_shared<StasiusN<T,DESCRIPTOR>>(converter, n);
  } else {
    throw std::invalid_argument(
      "Error: unknown projection name selected.");
  }
}

getInitialControl() [1/2]

template<typename T , typename DESCRIPTOR >

T olb::opti::projection::getInitialControl	(	T	startValue,
		const Base< T > &	projection,
		const UnitConverter< T, DESCRIPTOR > &	converter,
		StartValueType	type,
		bool	verbose = true )

Transform porosity/ permeability/ other startValue into control.

Definition at line 177 of file projection.h.

{
  T control {0};
  OstreamManager clout(std::cout, "getInitialControl");
 
  if (type == Porosity) {
    control = projection::porosityToControl(startValue, projection);
    if (verbose) {
      clout << "Transform porosity startValue into control startValue:\n";
      clout << "Porosity: " << startValue << std::endl;
      clout << "Control: " << control << std::endl;
    }
  }
  else if (type == Permeability) {
    const T tmpPorosity = projection::permeabilityToPorosity(startValue, converter);
    control = projection::porosityToControl(tmpPorosity, projection);
    if (verbose) {
      clout << "Transform permeability startValue into control startValue:\n";
      clout << "Permeability: " << startValue << std::endl;
      clout << "Porosity: " << tmpPorosity << std::endl;
      clout << "Control: " << control << std::endl;
    }
  }
  else if (type == ProjectedControl) {
    control = projection.inverse(startValue);
  } else if (type == Control) {
    control = startValue;
  } else {
    throw std::invalid_argument(
      "Error: unknown start value type.");
  }
  return control;
}

References olb::opti::control, olb::opti::Control, olb::opti::projection::Base< T >::inverse(), olb::opti::Permeability, permeabilityToPorosity(), olb::opti::Porosity, porosityToControl(), and olb::opti::ProjectedControl.

Here is the call graph for this function:

Here is the caller graph for this function:

getInitialControl() [2/2]

template<typename T , typename OptiCaseDual_Type >

T olb::opti::projection::getInitialControl	(	T	startValue,
		OptiCaseDual_Type &	optiCase )

Definition at line 216 of file projection.h.

{
  return getInitialControl(startValue,
    *(optiCase._projection),
    *(optiCase._converter),
    optiCase._startValueType,
    optiCase._verbose);
}

References getInitialControl().

Here is the call graph for this function:

gridTerm()

template<typename T , typename DESCRIPTOR >

T olb::opti::projection::gridTerm

(

const UnitConverter< T, DESCRIPTOR > &

converter

)

Definition at line 142 of file projection.h.

                                                         {
  return converter.getPhysDeltaX()
    * converter.getPhysDeltaX()
    * converter.getLatticeViscosity()
    * converter.getLatticeRelaxationTime();
}

References olb::UnitConverter< T, DESCRIPTOR >::getLatticeRelaxationTime(), olb::UnitConverter< T, DESCRIPTOR >::getLatticeViscosity(), and olb::UnitConverter< T, DESCRIPTOR >::getPhysDeltaX().

Here is the call graph for this function:

Here is the caller graph for this function:

permeabilityToControl()

template<typename T , typename DESCRIPTOR >

T olb::opti::projection::permeabilityToControl	(	T	permeability,
		const Base< T > &	projection,
		const UnitConverter< T, DESCRIPTOR > &	converter )

Get control for given permeability.

Definition at line 167 of file projection.h.

{
  const T porosity = permeabilityToPorosity(permeability, converter);
  return porosityToControl(porosity);
}

References permeabilityToPorosity(), and porosityToControl().

Here is the call graph for this function:

permeabilityToPorosity()

template<typename T , typename DESCRIPTOR >

T olb::opti::projection::permeabilityToPorosity	(	T	permeability,
		const UnitConverter< T, DESCRIPTOR > &	converter )

Get porosity for given permeability.

Definition at line 159 of file projection.h.

{
  return (T(1) - gridTerm(converter) / permeability);
}

References gridTerm().

Here is the call graph for this function:

Here is the caller graph for this function:

porosityToControl()

template<typename T >

T olb::opti::projection::porosityToControl	(	T	porosity,
		const Base< T > &	projection )

Get control value for given porosity.

Definition at line 152 of file projection.h.

{
  return projection.inverse(porosity);
}

References olb::opti::projection::Base< T >::inverse().

Here is the call graph for this function:

Here is the caller graph for this function: