MathLib::EigenVector Class Reference

Detailed Description

Global vector based on Eigen vector.

Definition at line 24 of file EigenVector.h.

#include <EigenVector.h>

Public Types
using	RawVectorType = Eigen::VectorXd
using	IndexType = Eigen::SparseMatrix<double>::Index

Public Member Functions
	EigenVector ()=default
	EigenVector (IndexType length)
IndexType	size () const
	return a vector length
IndexType	getRangeEnd () const
	return an end index of the active data range
void	setZero ()
double const &	operator[] (IndexType rowId) const
	access entry
double &	operator[] (IndexType rowId)
double	get (IndexType rowId) const
	get entry
std::vector< double >	get (std::vector< IndexType > const &indices) const
	get entries
void	set (IndexType rowId, double v)
	set entry
void	add (IndexType rowId, double v)
	add entry
template<class T_SUBVEC >
void	set (const std::vector< IndexType > &pos, const T_SUBVEC &sub_vec)
	set entries
template<class T_SUBVEC >
void	add (const std::vector< IndexType > &pos, const T_SUBVEC &sub_vec)
	add entries
void	copyValues (std::vector< double > &u) const
void	write (const std::string &filename) const
	write this vector to a file for debugging
RawVectorType &	getRawVector ()
	return a raw Eigen vector object
const RawVectorType &	getRawVector () const
	return a raw Eigen vector object

Static Public Member Functions
static constexpr IndexType	getRangeBegin ()
	return a start index of the active data range

Private Attributes
RawVectorType	vec_

Member Typedef Documentation

IndexType

using MathLib::EigenVector::IndexType = Eigen::SparseMatrix<double>::Index

Definition at line 32 of file EigenVector.h.

RawVectorType

using MathLib::EigenVector::RawVectorType = Eigen::VectorXd

Definition at line 27 of file EigenVector.h.

Constructor & Destructor Documentation

EigenVector() [1/2]

MathLib::EigenVector::EigenVector ( )

default

EigenVector() [2/2]

MathLib::EigenVector::EigenVector ( IndexType length )

inlineexplicit

Constructor for initialization of the number of rows

Parameters

length

number of rows

Definition at line 39 of file EigenVector.h.

: vec_(length) {}

Member Function Documentation

add() [1/2]

template<class T_SUBVEC >

void MathLib::EigenVector::add ( const std::vector< IndexType > & pos, const T_SUBVEC & sub_vec )

inline

add entries

Definition at line 91 of file EigenVector.h.

    {
        auto const length = pos.size();
        for (std::size_t i = 0; i < length; ++i)
        {
            add(pos[i], sub_vec[i]);
        }
    }

References add(), and set().

add() [2/2]

void MathLib::EigenVector::add ( IndexType rowId, double v )

inline

add entry

Definition at line 76 of file EigenVector.h.

{ vec_[rowId] += v; }

References set(), MathLib::v, and vec_.

Referenced by add(), ProcessLib::BoundaryConditionAndSourceTerm::Python::BcAndStLocalAssemblerImpl< BcOrStData, ShapeFunction, LowerOrderShapeFunction, GlobalDim >::assemble(), ProcessLib::NormalTractionBoundaryCondition::NormalTractionBoundaryConditionLocalAssembler< ShapeFunctionDisplacement, GlobalDim >::assemble(), ProcessLib::NeumannBoundaryConditionLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::RobinBoundaryConditionLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::VectorMatrixAssembler::assemble(), ProcessLib::HCNonAdvectiveFreeComponentFlowBoundaryConditionLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::VariableDependentNeumannBoundaryConditionLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::ComponentTransport::ComponentTransportLocalAssemblerInterface::assembleReactionEquation(), ProcessLib::VectorMatrixAssembler::assembleWithJacobian(), NumLib::LocalLinearLeastSquaresExtrapolator::extrapolateElement(), ProcessLib::NodalSourceTerm::integrate(), ProcessLib::VolumetricSourceTermLocalAssembler< ShapeFunction, GlobalDim >::integrate(), and ProcessLib::SmallDeformation::writeMaterialForces().

copyValues()

void MathLib::EigenVector::copyValues

(

std::vector< double > &

u

)

const

Copy local entries to a vector.

Parameters

u	a vector for the values of local entries. It will be resized to hold the current vector data.

Definition at line 21 of file EigenVector.cpp.

{
    u.resize(size());
    toVector(u) = vec_;
}

References size(), MathLib::toVector(), MathLib::u, and vec_.

Referenced by ProcessLib::PhaseField::PhaseFieldProcess< DisplacementDim >::assembleWithJacobianConcreteProcess(), ProcessLib::SmallDeformationNonlocal::SmallDeformationNonlocalProcess< DisplacementDim >::assembleWithJacobianConcreteProcess(), and copySolutionVector().

get() [1/2]

double MathLib::EigenVector::get ( IndexType rowId ) const

inline

get entry

Definition at line 58 of file EigenVector.h.

{ return vec_[rowId]; }

References set(), and vec_.

Referenced by anonymous_namespace{ParallelVectorMatrixAssembler.cpp}::assembleWithJacobianOneElement(), ProcessLib::SmallDeformationNonlocal::SmallDeformationNonlocalLocalAssembler< ShapeFunction, DisplacementDim >::computeCrackIntegral(), ProcessLib::LocalAssemblerInterface::computeSecondaryVariable(), ProcessLib::PrimaryVariableConstraintDirichletBoundaryCondition::getEssentialBCValues(), NumLib::getNodalValue(), NumLib::getNonGhostNodalValue(), ProcessLib::TES::TESProcess::postIterationConcreteProcess(), ProcessLib::VectorMatrixAssembler::preAssemble(), ProcessLib::LocalAssemblerInterface::preTimestep(), and ProcessLib::SmallDeformation::writeMaterialForces().

get() [2/2]

std::vector< double > MathLib::EigenVector::get ( std::vector< IndexType > const & indices ) const

inline

get entries

Definition at line 61 of file EigenVector.h.

    {
        std::vector<double> local_x;
        local_x.reserve(indices.size());
 
        transform(cbegin(indices), cend(indices), back_inserter(local_x),
                  [&](auto const i) { return vec_[i]; });
 
        return local_x;
    }

References set(), and vec_.

getRangeBegin()

static constexpr IndexType MathLib::EigenVector::getRangeBegin ( )

inlinestaticconstexpr

return a start index of the active data range

Definition at line 45 of file EigenVector.h.

{ return 0; }

Referenced by getIndexForComponentInSolutionVector().

getRangeEnd()

IndexType MathLib::EigenVector::getRangeEnd ( ) const

inline

return an end index of the active data range

Definition at line 48 of file EigenVector.h.

{ return size(); }

References size().

Referenced by getIndexForComponentInSolutionVector().

getRawVector() [1/2]

RawVectorType & MathLib::EigenVector::getRawVector ( )

inline

return a raw Eigen vector object

Definition at line 111 of file EigenVector.h.

{ return vec_; }

References vec_.

Referenced by MathLib::applyKnownSolution(), MathLib::EigenLisLinearSolver::solve(), MathLib::EigenLinearSolver::solve(), and MathLib::EigenLinearSolver::solve().

getRawVector() [2/2]

const RawVectorType & MathLib::EigenVector::getRawVector ( ) const

inline

return a raw Eigen vector object

Definition at line 114 of file EigenVector.h.

{ return vec_; }

References vec_.

operator[]() [1/2]

double & MathLib::EigenVector::operator[] ( IndexType rowId )

inline

Definition at line 55 of file EigenVector.h.

{ return vec_[rowId]; }

References set(), and vec_.

operator[]() [2/2]

double const & MathLib::EigenVector::operator[] ( IndexType rowId ) const

inline

access entry

Definition at line 54 of file EigenVector.h.

{ return vec_[rowId]; }

References set(), and vec_.

set() [1/2]

template<class T_SUBVEC >

void MathLib::EigenVector::set ( const std::vector< IndexType > & pos, const T_SUBVEC & sub_vec )

inline

set entries

Definition at line 80 of file EigenVector.h.

    {
        auto const length = pos.size();
        for (std::size_t i = 0; i < length; ++i)
        {
            set(pos[i], sub_vec[i]);
        }
    }

References set().

set() [2/2]

void MathLib::EigenVector::set ( IndexType rowId, double v )

inline

set entry

Definition at line 73 of file EigenVector.h.

{ vec_[rowId] = v; }

References set(), MathLib::v, and vec_.

Referenced by add(), add(), get(), get(), operator[](), operator[](), set(), set(), ProcessLib::PhaseField::PhaseFieldProcess< DisplacementDim >::updateConstraints(), and write().

setZero()

void MathLib::EigenVector::setZero ( )

inline

Definition at line 51 of file EigenVector.h.

{ vec_.setZero(); }

References vec_.

Referenced by ProcessLib::AssemblyMixin< Process >::assembleGeneric(), ProcessLib::ComponentTransport::ComponentTransportProcess::solveReactionEquation(), and ProcessLib::PhaseField::PhaseFieldProcess< DisplacementDim >::updateConstraints().

size()

IndexType MathLib::EigenVector::size ( ) const

inline

return a vector length

Definition at line 42 of file EigenVector.h.

{ return static_cast<IndexType>(vec_.size()); }

References vec_.

Referenced by copyValues(), and getRangeEnd().

write()

void MathLib::EigenVector::write

(

const std::string &

filename

)

const

write this vector to a file for debugging

Definition at line 28 of file EigenVector.cpp.

{
    std::ofstream os(filename);
    os << vec_;
}

References set(), and vec_.

Member Data Documentation

vec_

RawVectorType MathLib::EigenVector::vec_

private

Definition at line 117 of file EigenVector.h.

Referenced by add(), copyValues(), get(), get(), getRawVector(), getRawVector(), operator[](), operator[](), set(), setZero(), size(), and write().

---

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

• MathLib/LinAlg/Eigen/EigenVector.h
• MathLib/LinAlg/Eigen/EigenVector.cpp