Detailed Description

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

Class template PropertyVector is a std::vector with template parameter PROP_VAL_TYPE. The reason for the derivation of std::vector is the template specialisation for pointer types below.

Template Parameters

PROP_VAL_TYPE typical this is a scalar, a vector or a matrix

Definition at line 55 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 Member Functions
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

std::size_t	size () const

Public Member Functions inherited from MeshLib::PropertyVectorBase
virtual PropertyVectorBase *	clone (std::vector< std::size_t > const &exclude_positions) const =0

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)

Friends
class	Properties

Additional Inherited Members
Public Attributes inherited from MeshLib::PropertyVectorBase
bool	is_for_output = true

Protected Attributes inherited from MeshLib::PropertyVectorBase
int const	_n_components

MeshItemType const	_mesh_item_type

std::string const	_property_name

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 104 of file PropertyVector.h.

        : std::vector<PROP_VAL_TYPE>(),
          PropertyVectorBase(property_name, mesh_item_type, n_components)
    {
    }

◆ 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 119 of file PropertyVector.h.

        : std::vector<PROP_VAL_TYPE>(n_property_values * n_components),
          PropertyVectorBase(property_name, mesh_item_type, n_components)
    {
    }

Member Function Documentation

◆ 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 85 of file PropertyVector.h.

    {
        auto* t(new PropertyVector<PROP_VAL_TYPE>(
            _property_name, _mesh_item_type, _n_components));
        BaseLib::excludeObjectCopy(*this, exclude_positions, *t);
        return t;
    }

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

◆ 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 67 of file PropertyVector.h.

    {
        assert(component < _n_components);
        assert(tuple_index < getNumberOfTuples());
        return this->operator[](tuple_index* getNumberOfGlobalComponents() +
                                component);
    }

References MeshLib::PropertyVectorBase::_n_components, MeshLib::PropertyVectorBase::getNumberOfGlobalComponents(), and MeshLib::PropertyVector< PROP_VAL_TYPE >::getNumberOfTuples().

Referenced by ProcessLib::SurfaceFluxLocalAssembler< ShapeFunction, GlobalDim >::integrate(), ParameterLib::MeshElementParameter< T >::operator()(), ParameterLib::MeshNodeParameter< T >::operator()(), ParameterLib::RandomFieldMeshElementParameter< T >::operator()(), MeshToolsLib::processPropertyVector(), reorderProperty(), 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 76 of file PropertyVector.h.

    {
        assert(component < _n_components);
        assert(tuple_index < getNumberOfTuples());
        return this->operator[](tuple_index* getNumberOfGlobalComponents() +
                                component);
    }

References MeshLib::PropertyVectorBase::_n_components, MeshLib::PropertyVectorBase::getNumberOfGlobalComponents(), and MeshLib::PropertyVector< PROP_VAL_TYPE >::getNumberOfTuples().

◆ getNumberOfTuples()

template<typename PROP_VAL_TYPE >

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

inline

Definition at line 61 of file PropertyVector.h.

    {
        return std::vector<PROP_VAL_TYPE>::size() / _n_components;
    }

References MeshLib::PropertyVectorBase::_n_components.

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

◆ size()

template<typename PROP_VAL_TYPE >

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

inline

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

Definition at line 96 of file PropertyVector.h.

96{ return std::vector<PROP_VAL_TYPE>::size(); }

Referenced by ProcessLib::SolutionDependentDirichletBoundaryCondition::SolutionDependentDirichletBoundaryCondition(), MeshLib::VtkMappedMeshSource::addProperty(), MeshToolsLib::ElementValueModification::condense(), ApplicationUtils::copyFieldPropertyDataToPartitions(), ProcessLib::LIE::PostProcessTool::copyPropertyValues(), ApplicationUtils::copyPropertyVector(), createPropertyVector(), MeshLib::IO::NodePartitionedMeshReader::createPropertyVectorPart(), MeshLib::IO::NodePartitionedMeshReader::createSpecificPropertyVectorPart(), extractMatGroup(), MeshToolsLib::ElementValueModification::getSortedPropertyValues(), ProcessLib::SolutionDependentDirichletBoundaryCondition::postTimestep(), anonymous_namespace{MeshInformation.cpp}::printBounds(), MeshToolsLib::Mesh2MeshPropertyInterpolation::setPropertiesForMesh(), and ApplicationUtils::writePropertyVectorValues().

Friends And Related Function Documentation

◆ Properties

template<typename PROP_VAL_TYPE >

friend class Properties

friend

Definition at line 58 of file PropertyVector.h.

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

ChemistryLib/PhreeqcIOData/AqueousSolution.h
MeshLib/PropertyVector.h

Detailed Description

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ PropertyVector() [1/2]

◆ PropertyVector() [2/2]

Member Function Documentation

◆ clone()

◆ getComponent() [1/2]

◆ getComponent() [2/2]

◆ getNumberOfTuples()

◆ size()

Friends And Related Function Documentation

◆ Properties