#include <OptimCostBinary.hpp>

Inheritance diagram for OptimCostBinary:

Public Member Functions
	OptimCostBinary (const CGParam params=CGParam())

	OptimCostBinary (const OptimCostBinary &m)

OptimCostBinary &	operator= (const OptimCostBinary &m)

virtual	~OptimCostBinary ()

void	reset (PrecisionOp pmat, const ProjMatrix projdata, const ProjMatrix *projseis=nullptr, const VectorDouble &propseis=VectorDouble(), const VectorDouble &varseis=VectorDouble())

VectorDouble	minimize (VectorDouble &indic, bool verbose=false, int maxiter=100, double eps=5.e-4)

void	calculateGradient (const VectorDouble &indic, const VectorDouble &lambda, double *out)

int	setMeanProportion (double meanprop)

void	setParams (const CGParam &params)

void	setPreCondParams (int chebncmax=10001, double chebtol=5.e-3)

int	isInitialized ()

int	getNPoint () const

int	getNVertex () const

void	toggleSeismic (bool status)

Public Member Functions inherited from IOptimCost
	IOptimCost ()

virtual	~IOptimCost ()

Private Member Functions
double	_evaluateCost (const VectorDouble &indic, const VectorDouble &lambda)

void	_evaluateGrad (const VectorDouble &indic, const VectorDouble &lambda, double *normgrad)

void	_contributeSeismic (const VectorDouble &lambda)

void	_contributeSeismicDerivative (const VectorDouble &lambda)

Private Attributes
bool	_isInitialized

bool	_flagSeismic

double	_meanPropRaw

double	_meanPropGaus

PrecisionOp *	_pMat

const ProjMatrix *	_projData

const ProjMatrix *	_projSeis

VectorDouble	_propSeis

VectorDouble	_varSeis

CGParam	_params

bool	_flagCgPreCond

int	_chebNcmax

double	_chebTol

VectorDouble	_grad

VectorDouble	_workp

VectorDouble	_workx

VectorDouble	_workv

VectorDouble	_lambdav

VectorDouble	_works

Constructor & Destructor Documentation

◆ OptimCostBinary() [1/2]

OptimCostBinary::OptimCostBinary ( const CGParam params = CGParam() )

◆ OptimCostBinary() [2/2]

OptimCostBinary::OptimCostBinary ( const OptimCostBinary & m )

◆ ~OptimCostBinary()

OptimCostBinary::~OptimCostBinary ( )

virtual

Member Function Documentation

◆ _contributeSeismic()

void OptimCostBinary::_contributeSeismic ( const VectorDouble & lambda )

private

Internal function to evaluate the seismic contribution to cost function

Parameters

[in] lambda Array of input values

◆ _contributeSeismicDerivative()

void OptimCostBinary::_contributeSeismicDerivative ( const VectorDouble & lambda )

private

Internal function to evaluate the seismic contribution to gradient function

Parameters

[in] lambda Array of input values

◆ _evaluateCost()

double OptimCostBinary::_evaluateCost	(	const VectorDouble &	indic,
		const VectorDouble &	lambda
	)

private

Internal function to evaluate the Cost

Parameters

[in]	indic	Array containing the Facies indicators (Dimension: npoint)
[in]	lambda	Array of input values

◆ _evaluateGrad()

void OptimCostBinary::_evaluateGrad	(	const VectorDouble &	indic,
		const VectorDouble &	lambda,
		double *	normgrad
	)

private

Internal function to evaluate the Gradient

Parameters

[in]	indic	Array containing the Facies indicators (see remarks) (Dimension: npoint)
[in]	lambda	Array of input values
[out]	normgrad	Returnewd normalized gradient value

◆ calculateGradient()

void OptimCostBinary::calculateGradient	(	const VectorDouble &	indic,
		const VectorDouble &	lambda,
		double *	out
	)

virtual

Calculate the Gradient

Parameters

[in]	indic	Array containing the Facies indicators (see remarks) (Dimension: npoint)
[in]	lambda	Array of input values
[out]	out	Array of output gradients

Implements IOptimCost.

◆ getNPoint()

int OptimCostBinary::getNPoint ( ) const

Returns the Number of Data Points

◆ getNVertex()

int OptimCostBinary::getNVertex ( ) const

Returns the Number of Meshing Vertices

◆ isInitialized()

int OptimCostBinary::isInitialized ( )

inline

◆ minimize()

VectorDouble OptimCostBinary::minimize	(	VectorDouble &	indic,
		bool	verbose = `false`,
		int	maxiter = `100`,
		double	eps = `5.e-4`
	)

Perform the minimization

Returns: The array of facies proportions (Dimension: nvertex)

Parameters

[in]	indic	Array containing the Facies indicators (see remarks) (Dimension: npoint)
[in]	verbose	Verbose flag
[in]	maxiter	Maximum number of iterations for Optimization algo.
[in]	eps	Tolerance for Optimization algorithm

Remarks: The argument 'indic' should contain 0 or 1 for active constraints; The inactive constraints should be set to TEST.

◆ operator=()

OptimCostBinary & OptimCostBinary::operator= ( const OptimCostBinary & m )

◆ reset()

void OptimCostBinary::reset	(	PrecisionOp *	pmat,
		const ProjMatrix *	projdata,
		const ProjMatrix *	projseis = `nullptr`,
		const VectorDouble &	propseis = `VectorDouble()`,
		const VectorDouble &	varseis = `VectorDouble()`
	)

Initialize the Binary Cost Operator

Parameters

[in]	pmat	The precision matrix to be optimized
[in]	projdata	The Projection operator between Data and Meshing
[in]	projseis	The Projection operator between Seismic and Meshing
[in]	propseis	Array of facies proportions
[in]	varseis	Array of variance attached to the seismic

◆ setMeanProportion()

int OptimCostBinary::setMeanProportion ( double meanprop )

Set the Mean proportion for the indicator

Parameters

[in] meanprop Value of the mean proportion (raw scale)

◆ setParams()

void OptimCostBinary::setParams ( const CGParam & params )

inline

◆ setPreCondParams()

void OptimCostBinary::setPreCondParams	(	int	chebncmax = `10001`,
		double	chebtol = `5.e-3`
	)

inline

Set the constant parameters for internal Pre-Conditioner

◆ toggleSeismic()

void OptimCostBinary::toggleSeismic ( bool status )

Toggle the use of the Seismic constraint

Parameters

[in] status Status assigned to the Seismic Constraints

Remarks: When the Seismic is not defined (i.e. 'projSeis not defined); this function is useless

Member Data Documentation

◆ _chebNcmax

int OptimCostBinary::_chebNcmax

private

◆ _chebTol

double OptimCostBinary::_chebTol

private

◆ _flagCgPreCond

bool OptimCostBinary::_flagCgPreCond

private

◆ _flagSeismic

bool OptimCostBinary::_flagSeismic

private

◆ _grad

VectorDouble OptimCostBinary::_grad

mutableprivate

◆ _isInitialized

bool OptimCostBinary::_isInitialized

private

◆ _lambdav

VectorDouble OptimCostBinary::_lambdav

mutableprivate

◆ _meanPropGaus

double OptimCostBinary::_meanPropGaus

private

◆ _meanPropRaw

double OptimCostBinary::_meanPropRaw

private

◆ _params

CGParam OptimCostBinary::_params

private

◆ _pMat

PrecisionOp* OptimCostBinary::_pMat

private

◆ _projData

const ProjMatrix* OptimCostBinary::_projData

private

◆ _projSeis

const ProjMatrix* OptimCostBinary::_projSeis

private

◆ _propSeis

VectorDouble OptimCostBinary::_propSeis

private

◆ _varSeis

VectorDouble OptimCostBinary::_varSeis

private

◆ _workp

VectorDouble OptimCostBinary::_workp

mutableprivate

◆ _works

VectorDouble OptimCostBinary::_works

mutableprivate

◆ _workv

VectorDouble OptimCostBinary::_workv

mutableprivate

◆ _workx

VectorDouble OptimCostBinary::_workx

mutableprivate

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

include/LinearOp/OptimCostBinary.hpp
src/LinearOp/OptimCostBinary.cpp

Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ OptimCostBinary() [1/2]

◆ OptimCostBinary() [2/2]

◆ ~OptimCostBinary()

Member Function Documentation

◆ _contributeSeismic()

◆ _contributeSeismicDerivative()

◆ _evaluateCost()

◆ _evaluateGrad()

◆ calculateGradient()

◆ getNPoint()

◆ getNVertex()

◆ isInitialized()

◆ minimize()

◆ operator=()

◆ reset()

◆ setMeanProportion()

◆ setParams()

◆ setPreCondParams()

◆ toggleSeismic()

Member Data Documentation

◆ _chebNcmax

◆ _chebTol

◆ _flagCgPreCond

◆ _flagSeismic

◆ _grad

◆ _isInitialized

◆ _lambdav

◆ _meanPropGaus

◆ _meanPropRaw

◆ _params

◆ _pMat

◆ _projData

◆ _projSeis

◆ _propSeis

◆ _varSeis

◆ _workp

◆ _works

◆ _workv

◆ _workx