Detailed Description

template<typename PROP_VAL_TYPE>
class MeshLib::PropertyVector< PROP_VAL_TYPE >

Contiguous storage for the values of one named mesh property. Values are laid out tuple-contiguous: the component of a tuple is at tuple_index * n_components + component, so the components of one tuple are adjacent in memory. Instances are created and owned by Properties.

Template Parameters

PROP_VAL_TYPE typically a scalar, a vector or a matrix

Definition at line 65 of file PropertyVector.h.

#include <PropertyVector.h>

Inheritance diagram for MeshLib::PropertyVector< PROP_VAL_TYPE >:

[legend]

Collaboration diagram for MeshLib::PropertyVector< PROP_VAL_TYPE >:

[legend]

Public Types
using	value_type = PROP_VAL_TYPE

Public Member Functions
constexpr std::size_t	getNumberOfTuples () const
PROP_VAL_TYPE &	getComponent (std::size_t tuple_index, int component)
	Returns the value for the given component stored in the given tuple.
PROP_VAL_TYPE const &	getComponent (std::size_t tuple_index, int component) const
	Returns the value for the given component stored in the given tuple.
PropertyVectorBase *	clone (std::vector< std::size_t > const &exclude_positions) const override
constexpr std::size_t	size () const
constexpr std::ptrdiff_t	ssize () const
constexpr const PROP_VAL_TYPE *	data () const
constexpr PROP_VAL_TYPE *	data ()
constexpr PROP_VAL_TYPE *	begin ()
constexpr PROP_VAL_TYPE *	end ()
constexpr const PROP_VAL_TYPE *	cbegin () const
constexpr const PROP_VAL_TYPE *	cend () const
constexpr const PROP_VAL_TYPE *	begin () const
constexpr const PROP_VAL_TYPE *	end () const
constexpr PROP_VAL_TYPE &	operator[] (std::size_t const pos)
constexpr PROP_VAL_TYPE const &	operator[] (std::size_t const pos) const
constexpr void	resize (std::size_t const size)
constexpr void	resize (std::size_t const size, const PROP_VAL_TYPE &value)
template<typename R> requires std::ranges::input_range<R> && std::convertible_to<std::ranges::range_value_t<R>, PROP_VAL_TYPE>
constexpr void	assign (R &&r)
constexpr void	clear ()
constexpr bool	empty () const
Public Member Functions inherited from MeshLib::PropertyVectorBase
virtual	~PropertyVectorBase ()=default
MeshItemType	getMeshItemType () const
std::string const &	getPropertyName () const
int	getNumberOfGlobalComponents () const

Protected Member Functions
	PropertyVector (std::string const &property_name, MeshItemType mesh_item_type, std::size_t n_components)
	The constructor taking meta information for the data.
	PropertyVector (std::size_t n_property_values, std::string const &property_name, MeshItemType mesh_item_type, std::size_t n_components)
	The constructor taking meta information for the data.
Protected Member Functions inherited from MeshLib::PropertyVectorBase
	PropertyVectorBase (std::string property_name, MeshItemType mesh_item_type, std::size_t n_components)

Private Attributes
std::vector< PROP_VAL_TYPE >	data_

Friends
class	Properties

Additional Inherited Members
Protected Attributes inherited from MeshLib::PropertyVectorBase
int const	_n_components
MeshItemType const	_mesh_item_type
std::string const	_property_name

Member Typedef Documentation

◆ value_type

template<typename PROP_VAL_TYPE>

using MeshLib::PropertyVector< PROP_VAL_TYPE >::value_type = PROP_VAL_TYPE

Definition at line 70 of file PropertyVector.h.

Constructor & Destructor Documentation

◆ PropertyVector() [1/2]

template<typename PROP_VAL_TYPE>

MeshLib::PropertyVector< PROP_VAL_TYPE >::PropertyVector	(	std::string const &	property_name,
		MeshItemType	mesh_item_type,
		std::size_t	n_components )

inlineexplicitprotected

The constructor taking meta information for the data.

Parameters

property_name	a string describing the property
mesh_item_type	the values of the property are either assigned to nodes or cells (see enumeration MeshItemType)
n_components	the number of components of a property

Definition at line 189 of file PropertyVector.h.

        : PropertyVectorBase(property_name, mesh_item_type, n_components)
    {
    }

References MeshLib::PropertyVectorBase::PropertyVectorBase().

Referenced by clone().

◆ PropertyVector() [2/2]

template<typename PROP_VAL_TYPE>

MeshLib::PropertyVector< PROP_VAL_TYPE >::PropertyVector	(	std::size_t	n_property_values,
		std::string const &	property_name,
		MeshItemType	mesh_item_type,
		std::size_t	n_components )

inlineprotected

The constructor taking meta information for the data.

Parameters

n_property_values	number of property values (value can be a tuple with several entries)
property_name	a string describing the property
mesh_item_type	the values of the property are either assigned to nodes or cells (see enumeration MeshItemType)
n_components	the number of components of a property

Definition at line 203 of file PropertyVector.h.

        : PropertyVectorBase(property_name, mesh_item_type, n_components),
          data_(n_property_values * n_components)
    {
    }

References MeshLib::PropertyVectorBase::PropertyVectorBase(), and data_.

Member Function Documentation

◆ assign()

template<typename PROP_VAL_TYPE>

template<typename R>
requires std::ranges::input_range<R> && std::convertible_to<std::ranges::range_value_t<R>, PROP_VAL_TYPE>

void MeshLib::PropertyVector< PROP_VAL_TYPE >::assign ( R && r )

inlineconstexpr

Definition at line 163 of file PropertyVector.h.

    {
#if __cpp_lib_containers_ranges >= 202202L
        data_.assign_range(r);
#else
        if constexpr (ranges::common_range<R>)
        {
            data_.assign(r.begin(), r.end());
        }
        else
        {
            data_.assign(ranges::views::common(r).begin(),
                         ranges::views::common(r).end());
        }
#endif
    }

References begin(), data_, and end().

Referenced by Vtu2GridDialog::accept(), addGlobalIDsToMesh(), MeshToolsLib::ElementValueModification::condense(), MeshLib::VtkMeshConverter::convertTypedArray(), copyDoubleValuedFieldDataToPointCloud(), MeshToolsLib::MeshLayerMapper::createStaticLayers(), FileIO::GMSInterface::readMesh(), FileIO::SwmmInterface::readSwmmInputToLineMesh(), FileIO::TetGenInterface::readTetGenMesh(), and writeDataToMesh().

◆ begin() [1/2]

template<typename PROP_VAL_TYPE>

PROP_VAL_TYPE * MeshLib::PropertyVector< PROP_VAL_TYPE >::begin ( )

inlineconstexpr

Definition at line 115 of file PropertyVector.h.

115{ return data_.data(); }

References data_.

Referenced by FileIO::SwmmInterface::addResultsToMesh(), assign(), ApplicationUtils::copyFieldPropertyDataToPartitions(), ProcessLib::LIE::PostProcessTool::copyPropertyValues(), MeshToolsLib::createCellProperties(), MeshToolsLib::createIntegrationPointProperties(), MeshToolsLib::createMergedPropertyVector(), MeshToolsLib::createNodeProperties(), createPropertyVector(), main(), MaterialLib::parseMaterialIdString(), and MeshToolsLib::setSigma0().

◆ begin() [2/2]

template<typename PROP_VAL_TYPE>

const PROP_VAL_TYPE * MeshLib::PropertyVector< PROP_VAL_TYPE >::begin ( ) const

inlineconstexpr

Definition at line 123 of file PropertyVector.h.

123{ return cbegin(); }

MeshLib::PropertyVector::cbegin

constexpr const PROP_VAL_TYPE * cbegin() const

Definition PropertyVector.h:118

References cbegin().

◆ cbegin()

template<typename PROP_VAL_TYPE>

const PROP_VAL_TYPE * MeshLib::PropertyVector< PROP_VAL_TYPE >::cbegin ( ) const

inlineconstexpr

Definition at line 118 of file PropertyVector.h.

118{ return data_.data(); }

References data_.

Referenced by begin(), main(), and MeshElementRemovalDialog::setRangeValues().

◆ cend()

template<typename PROP_VAL_TYPE>

const PROP_VAL_TYPE * MeshLib::PropertyVector< PROP_VAL_TYPE >::cend ( ) const

inlineconstexpr

Definition at line 119 of file PropertyVector.h.

    {
        return data_.data() + data_.size();
    }

References data_.

Referenced by end(), main(), and MeshElementRemovalDialog::setRangeValues().

◆ clear()

template<typename PROP_VAL_TYPE>

void MeshLib::PropertyVector< PROP_VAL_TYPE >::clear ( )

inlineconstexpr

Definition at line 180 of file PropertyVector.h.

180{ data_.clear(); }

References data_.

◆ clone()

template<typename PROP_VAL_TYPE>

PropertyVectorBase * MeshLib::PropertyVector< PROP_VAL_TYPE >::clone ( std::vector< std::size_t > const & exclude_positions ) const

inlineoverridevirtual

Implements MeshLib::PropertyVectorBase.

Definition at line 95 of file PropertyVector.h.

    {
        auto* cloned_pv = new PropertyVector<PROP_VAL_TYPE>(
            _property_name, _mesh_item_type, _n_components);
        cloned_pv->data_ = BaseLib::excludeObjectCopy(data_, exclude_positions);
        return cloned_pv;
    }

References PropertyVector(), MeshLib::PropertyVectorBase::PropertyVectorBase(), MeshLib::PropertyVectorBase::_mesh_item_type, MeshLib::PropertyVectorBase::_n_components, MeshLib::PropertyVectorBase::_property_name, data_, and BaseLib::excludeObjectCopy().

◆ data() [1/2]

template<typename PROP_VAL_TYPE>

PROP_VAL_TYPE * MeshLib::PropertyVector< PROP_VAL_TYPE >::data ( )

inlineconstexpr

Definition at line 113 of file PropertyVector.h.

113{ return data_.data(); }

References data_.

◆ data() [2/2]

template<typename PROP_VAL_TYPE>

const PROP_VAL_TYPE * MeshLib::PropertyVector< PROP_VAL_TYPE >::data ( ) const

inlineconstexpr

Definition at line 112 of file PropertyVector.h.

112{ return data_.data(); }

References data_.

Referenced by MeshLib::VtkMappedMeshSource::addProperty(), MeshLib::IO::NodePartitionedMeshReader::createPropertyVectorPart(), MeshLib::IO::NodePartitionedMeshReader::createSpecificPropertyVectorPart(), and ApplicationUtils::writePropertyVectorValues().

◆ empty()

template<typename PROP_VAL_TYPE>

bool MeshLib::PropertyVector< PROP_VAL_TYPE >::empty ( ) const

inlineconstexpr

Definition at line 181 of file PropertyVector.h.

181{ return data_.empty(); }

References data_.

Referenced by MeshToolsLib::MeshInformation::getValueBounds(), and MeshLib::nextUnusedMaterialId().

◆ end() [1/2]

template<typename PROP_VAL_TYPE>

PROP_VAL_TYPE * MeshLib::PropertyVector< PROP_VAL_TYPE >::end ( )

inlineconstexpr

Definition at line 116 of file PropertyVector.h.

116{ return data_.data() + data_.size(); }

References data_.

Referenced by assign(), ProcessLib::LIE::PostProcessTool::copyPropertyValues(), MeshToolsLib::createCellProperties(), MeshToolsLib::createIntegrationPointProperties(), MeshToolsLib::createMergedPropertyVector(), MeshToolsLib::createNodeProperties(), main(), MaterialLib::parseMaterialIdString(), and MeshToolsLib::setSigma0().

◆ end() [2/2]

template<typename PROP_VAL_TYPE>

const PROP_VAL_TYPE * MeshLib::PropertyVector< PROP_VAL_TYPE >::end ( ) const

inlineconstexpr

Definition at line 124 of file PropertyVector.h.

124{ return cend(); }

MeshLib::PropertyVector::cend

constexpr const PROP_VAL_TYPE * cend() const

Definition PropertyVector.h:119

References cend().

◆ getComponent() [1/2]

template<typename PROP_VAL_TYPE>

PROP_VAL_TYPE & MeshLib::PropertyVector< PROP_VAL_TYPE >::getComponent	(	std::size_t	tuple_index,
		int	component )

inline

Returns the value for the given component stored in the given tuple.

Definition at line 79 of file PropertyVector.h.

    {
        assert(component < _n_components);
        assert(tuple_index < getNumberOfTuples());
        return data_[tuple_index * getNumberOfGlobalComponents() + component];
    }

References MeshLib::PropertyVectorBase::_n_components, data_, MeshLib::PropertyVectorBase::getNumberOfGlobalComponents(), and getNumberOfTuples().

Referenced by ProcessLib::SurfaceFluxLocalAssembler< ShapeFunction, GlobalDim >::integrate(), MeshToolsLib::processPropertyVector(), reorderProperty(), NumLib::transformVariableFromGlobalVector(), and NumLib::transformVariableFromGlobalVector().

◆ getComponent() [2/2]

template<typename PROP_VAL_TYPE>

PROP_VAL_TYPE const & MeshLib::PropertyVector< PROP_VAL_TYPE >::getComponent	(	std::size_t	tuple_index,
		int	component ) const

inline

Returns the value for the given component stored in the given tuple.

Definition at line 87 of file PropertyVector.h.

    {
        assert(component < _n_components);
        assert(tuple_index < getNumberOfTuples());
        return data_[tuple_index * getNumberOfGlobalComponents() + component];
    }

References MeshLib::PropertyVectorBase::_n_components, data_, MeshLib::PropertyVectorBase::getNumberOfGlobalComponents(), and getNumberOfTuples().

◆ getNumberOfTuples()

template<typename PROP_VAL_TYPE>

std::size_t MeshLib::PropertyVector< PROP_VAL_TYPE >::getNumberOfTuples ( ) const

inlineconstexpr

Definition at line 73 of file PropertyVector.h.

    {
        return size() / _n_components;
    }

References MeshLib::PropertyVectorBase::_n_components, and size().

Referenced by getComponent(), getComponent(), MeshToolsLib::ElementValueModification::replace(), MeshLib::ElementSearch::searchByPropertyValueRange(), MeshLib::IO::transformAttribute(), and ApplicationUtils::writePropertyVector().

◆ operator[]() [1/2]

template<typename PROP_VAL_TYPE>

PROP_VAL_TYPE & MeshLib::PropertyVector< PROP_VAL_TYPE >::operator[] ( std::size_t const pos )

inlineconstexpr

Definition at line 126 of file PropertyVector.h.

    {
        if constexpr (std::is_same_v<PROP_VAL_TYPE, bool>)
        {
            static_assert(false,
                          "PropertyVector<bool>::operator[] cannot be "
                          "instantiated for booleans.");
        }
        else
        {
            return data_[pos];
        }
    }

References data_.

◆ operator[]() [2/2]

template<typename PROP_VAL_TYPE>

PROP_VAL_TYPE const & MeshLib::PropertyVector< PROP_VAL_TYPE >::operator[] ( std::size_t const pos ) const

inlineconstexpr

Definition at line 139 of file PropertyVector.h.

    {
        if constexpr (std::is_same_v<PROP_VAL_TYPE, bool>)
        {
            static_assert(false,
                          "PropertyVector<bool>::operator[] cannot be "
                          "instantiated for booleans.");
        }
        else
        {
            return data_[pos];
        }
    }

References data_.

◆ resize() [1/2]

template<typename PROP_VAL_TYPE>

void MeshLib::PropertyVector< PROP_VAL_TYPE >::resize ( std::size_t const size )

inlineconstexpr

Definition at line 153 of file PropertyVector.h.

153{ data_.resize(size); }

References data_, and size().

Referenced by FileIO::Gocad::GocadAsciiReader::appendSectionMaterialIds(), MeshLib::IO::NodePartitionedMeshReader::createPropertyVectorPart(), MeshLib::IO::NodePartitionedMeshReader::createSpecificPropertyVectorPart(), and FileIO::SwmmInterface::readSwmmInputToLineMesh().

◆ resize() [2/2]

template<typename PROP_VAL_TYPE>

void MeshLib::PropertyVector< PROP_VAL_TYPE >::resize	(	std::size_t const	size,
		const PROP_VAL_TYPE &	value )

inlineconstexpr

Definition at line 154 of file PropertyVector.h.

    {
        data_.resize(size, value);
    }

References data_, and size().

◆ size()

template<typename PROP_VAL_TYPE>

std::size_t MeshLib::PropertyVector< PROP_VAL_TYPE >::size ( ) const

inlineconstexpr

Method returns the number of tuples times the number of tuple components.

Definition at line 106 of file PropertyVector.h.

106{ return data_.size(); }

References data_.

Referenced by MeshLib::VtkMappedMeshSource::addProperty(), ApplicationUtils::copyFieldPropertyDataToPartitions(), ProcessLib::LIE::PostProcessTool::copyPropertyValues(), ApplicationUtils::copyPropertyVector(), MeshToolsLib::createCellProperties(), MeshToolsLib::createMergedPropertyVector(), MeshToolsLib::createNodeProperties(), MeshLib::IO::NodePartitionedMeshReader::createPropertyVectorPart(), MeshLib::IO::NodePartitionedMeshReader::createSpecificPropertyVectorPart(), getNumberOfTuples(), MeshToolsLib::ElementValueModification::getSortedPropertyValues(), MeshToolsLib::MeshGenerator::VoxelGridFromMesh::mapArray(), anonymous_namespace{MeshInformation.cpp}::printBounds(), resize(), resize(), FileIO::FEFLOWMeshInterface::setMaterialIDs(), MeshToolsLib::Mesh2MeshPropertyInterpolation::setPropertiesForMesh(), MeshToolsLib::setSigma0(), transfer(), and ApplicationUtils::writePropertyVectorValues().

◆ ssize()

template<typename PROP_VAL_TYPE>

std::ptrdiff_t MeshLib::PropertyVector< PROP_VAL_TYPE >::ssize ( ) const

inlineconstexpr

Definition at line 108 of file PropertyVector.h.

108{ return std::ssize(data_); }

References data_.

◆ Properties

template<typename PROP_VAL_TYPE>

friend class Properties

friend

Definition at line 67 of file PropertyVector.h.

References Properties.

Referenced by Properties.

Member Data Documentation

◆ data_

template<typename PROP_VAL_TYPE>

std::vector<PROP_VAL_TYPE> MeshLib::PropertyVector< PROP_VAL_TYPE >::data_

private

Definition at line 213 of file PropertyVector.h.

Referenced by PropertyVector(), assign(), begin(), cbegin(), cend(), clear(), clone(), data(), data(), empty(), end(), getComponent(), getComponent(), operator[](), operator[](), resize(), resize(), size(), and ssize().

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

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ value_type

Constructor & Destructor Documentation

◆ PropertyVector() [1/2]

◆ PropertyVector() [2/2]

Member Function Documentation

◆ assign()

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ clear()

◆ clone()

◆ data() [1/2]

◆ data() [2/2]

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ getComponent() [1/2]

◆ getComponent() [2/2]

◆ getNumberOfTuples()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ resize() [1/2]

◆ resize() [2/2]

◆ size()

◆ ssize()

Friends And Related Symbol Documentation

◆ Properties

Member Data Documentation

◆ data_