Implementation of VectorAccessInterface for adjoint vectors. More...

#include <adjointVectorAccess.hpp>

Inheritance diagram for codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >:

[legend]

Public Types
using	AdjointVector = T_AdjointVector
	See AdjointVectorAccess.

using	Gradient = AdjointVectorTraits::Gradient<T_AdjointVector>
	Adjoint vector entry type.

using	Identifier = T_Identifier
	See AdjointVectorAccess.

using	Real = T_Real
	See AdjointVectorAccess.

Public Types inherited from codi::VectorAccessInterface< T_Real, T_Identifier >
using	Identifier = T_Identifier
	See VectorAccessInterface.

using	Real = T_Real
	See VectorAccessInterface.

Public Member Functions
	AdjointVectorAccess (AdjointVector adjointVector)
	Constructor. See interface documentation for details about the adjoint vector.

Misc
size_t	getVectorSize () const
	Vector size in the current tape evaluation.

bool	isLhsZero ()
	True if the adjoint set with setLhsAdjoint is zero.

VectorAccessInterface< Real, Identifier > *	clone () const

Indirect adjoint access
void	setLhsAdjoint (Identifier const &index)

void	updateAdjointWithLhs (Identifier const &index, Real const &jacobian)

Indirect tangent access
void	setLhsTangent (Identifier const &index)

void	updateTangentWithLhs (Identifier const &index, Real const &jacobian)

Indirect adjoint/tangent access for functions with multiple outputs
void	setActiveVariableForIndirectAccess (size_t pos)

Direct adjoint access
void	resetAdjoint (Identifier const &index, size_t dim)
	Set the adjoint component to zero.

void	resetAdjointVec (Identifier const &index)
	Set the adjoint entry to zero.

Real	getAdjoint (Identifier const &index, size_t dim)
	Get the adjoint component.

void	getAdjointVec (Identifier const &index, Real *const vec)
	Get the adjoint entry.

Real const *	getAdjointVec (Identifier const &index)
	Get the adjoint entry.

void	updateAdjoint (Identifier const &index, size_t dim, Real const &adjoint)
	Update the adjoint component.

void	updateAdjointVec (Identifier const &index, Real const *const vec)
	Update the adjoint entry.

Primal access
void	setPrimal (Identifier const &index, Real const &primal)
	Set the primal value.

Real	getPrimal (Identifier const &index)
	Get the primal value.

bool	hasPrimals ()
	Set the primal value.

Public Member Functions inherited from codi::VectorAccessInterface< T_Real, T_Identifier >
virtual	~VectorAccessInterface ()
	Destructor.

Protected Attributes
AdjointVector	adjointVector
	Pointer/reference to an array-accessible collection of gradients.

Detailed Description

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>
struct codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >

Implementation of VectorAccessInterface for adjoint vectors.

The adjoint vector is used as is, it is assumed to have the correct size. No bounds checking is performed.

Template Parameters

T_Real	The computation type of a tape, usually chosen as ActiveType::Real.
T_Identifier	The adjoint/tangent identification of a tape, usually chosen as ActiveType::Identifier.
T_AdjointVector	Either a pointer type, for example Gradient*, or a reference to something that can be accessed like a gradient array, for example std::vector<Gradient>&.

Member Function Documentation

◆ clone()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

VectorAccessInterface< Real, Identifier > * codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::clone ( ) const

inlinevirtual

Obtain a heap-allocated copy of the vector access inter- face. The user is responsible for deleting the pointer.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

Reimplemented in codi::PrimalAdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >, codi::PrimalAdjointVectorAccess< Real, Identifier, AdjointVector >, and codi::PrimalAdjointVectorAccess< Real, Identifier, AdjointVector >.

◆ getAdjoint()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

Real codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::getAdjoint	(	Identifier const &	index,
		size_t	dim )

inlinevirtual

Get the adjoint component.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ getAdjointVec() [1/2]

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

Real const * codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::getAdjointVec ( Identifier const & index )

inlinevirtual

Get the adjoint entry.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ getAdjointVec() [2/2]

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

void codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::getAdjointVec	(	Identifier const &	index,
		Real *const	vec )

inlinevirtual

Get the adjoint entry.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ getPrimal()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

Real codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::getPrimal ( Identifier const & index )

inlinevirtual

Get the primal value.

Implementation: Not implemented, returns zero.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

Reimplemented in codi::PrimalAdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >, codi::PrimalAdjointVectorAccess< Real, Identifier, AdjointVector >, and codi::PrimalAdjointVectorAccess< Real, Identifier, AdjointVector >.

◆ getVectorSize()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

size_t codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::getVectorSize ( ) const

inlinevirtual

Vector size in the current tape evaluation.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ hasPrimals()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

bool codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::hasPrimals ( )

inlinevirtual

Set the primal value.

Implementation: Always returns false.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

Reimplemented in codi::PrimalAdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >, codi::PrimalAdjointVectorAccess< Real, Identifier, AdjointVector >, and codi::PrimalAdjointVectorAccess< Real, Identifier, AdjointVector >.

◆ isLhsZero()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

bool codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::isLhsZero ( )

inlinevirtual

True if the adjoint set with setLhsAdjoint is zero.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ resetAdjoint()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

void codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::resetAdjoint	(	Identifier const &	index,
		size_t	dim )

inlinevirtual

Set the adjoint component to zero.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ resetAdjointVec()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

void codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::resetAdjointVec ( Identifier const & index )

inlinevirtual

Set the adjoint entry to zero.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ setActiveVariableForIndirectAccess()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

void codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::setActiveVariableForIndirectAccess ( size_t pos )

inlinevirtual

Set for the other indirect access routines.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ setLhsAdjoint()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

void codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::setLhsAdjoint ( Identifier const & index )

inlinevirtual

Identify the lhs variable . Create an internal copy of $\bar w$ and set $\bar w$ to zero.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ setLhsTangent()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

void codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::setLhsTangent ( Identifier const & index )

inlinevirtual

Perform $\dot w = \text{internalMem}$ . Internal memory is reset afterwards.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ setPrimal()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

void codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::setPrimal	(	Identifier const &	index,
		Real const &	primal )

inlinevirtual

Set the primal value.

Implementation: Not implemented, empty function.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

Reimplemented in codi::PrimalAdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >, codi::PrimalAdjointVectorAccess< Real, Identifier, AdjointVector >, and codi::PrimalAdjointVectorAccess< Real, Identifier, AdjointVector >.

◆ updateAdjoint()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

void codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::updateAdjoint	(	Identifier const &	index,
		size_t	dim,
		Real const &	adjoint )

inlinevirtual

Update the adjoint component.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ updateAdjointVec()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

void codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::updateAdjointVec	(	Identifier const &	index,
		Real const *const	vec )

inlinevirtual

Update the adjoint entry.

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ updateAdjointWithLhs()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

void codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::updateAdjointWithLhs	(	Identifier const &	index,
		Real const &	jacobian )

inlinevirtual

Perform $\bar u_{\text{index}} \aeq \text{jacobian} * \bar w$

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

◆ updateTangentWithLhs()

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>

void codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::updateTangentWithLhs	(	Identifier const &	index,
		Real const &	jacobian )

inlinevirtual

Perform $\text{internalMem} \aeq jacobian * < \dot u_{\text{index}}$ .

Implements codi::VectorAccessInterface< T_Real, T_Identifier >.

The documentation for this struct was generated from the following file:

include/codi/tapes/misc/adjointVectorAccess.hpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ clone()

◆ getAdjoint()

◆ getAdjointVec() [1/2]

◆ getAdjointVec() [2/2]

◆ getPrimal()

◆ getVectorSize()

◆ hasPrimals()

◆ isLhsZero()

◆ resetAdjoint()

◆ resetAdjointVec()

◆ setActiveVariableForIndirectAccess()

◆ setLhsAdjoint()

◆ setLhsTangent()

◆ setPrimal()

◆ updateAdjoint()

◆ updateAdjointVec()

◆ updateAdjointWithLhs()

◆ updateTangentWithLhs()