Templated 3D Vector derived from VectorSpace adding construction from 3 components, element access using x(), y() and z() member functions and the inner-product (dot-product) and cross product operators. More...

Inheritance diagram for Vector< Cmpt >:

[legend]

Collaboration diagram for Vector< Cmpt >:

[legend]

Public Types
enum	components { X , Y , Z }
	Component labeling enumeration. More...

typedef Vector< label >	labelType
	Equivalent type of labels used for valid component indexing. More...

Public Types inherited from VectorSpace< Vector< Cmpt >, Cmpt, 3 >
typedef VectorSpace< Vector< Cmpt >, Cmpt, Ncmpts >	vsType
	VectorSpace type. More...

typedef Cmpt	cmptType
	Component type. More...

Public Member Functions
	Vector ()
	Construct null. More...

	Vector (const Foam::zero)
	Construct initialised to zero. More...

template<class Cmpt2 >
	Vector (const VectorSpace< Vector< Cmpt2 >, Cmpt2, 3 > &)
	Construct given VectorSpace of the same rank. More...

	Vector (const Cmpt &vx, const Cmpt &vy, const Cmpt &vz)
	Construct given three components. More...

	Vector (Istream &)
	Construct from Istream. More...

const Cmpt &	x () const

const Cmpt &	y () const

const Cmpt &	z () const

Cmpt &	x ()

Cmpt &	y ()

Cmpt &	z ()

const Vector< Cmpt > &	centre (const Foam::List< Vector< Cmpt >> &) const
	Return *this (used for point which is a typedef to Vector<scalar>. More...

Public Member Functions inherited from VectorSpace< Vector< Cmpt >, Cmpt, 3 >
	VectorSpace ()
	Construct null. More...

	VectorSpace (const Foam::zero)
	Construct initialised to zero. More...

	VectorSpace (Istream &)
	Construct from Istream. More...

	VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
	Construct as copy of a VectorSpace with the same size. More...

const Cmpt &	component (const direction) const

Cmpt &	component (const direction)

void	component (Cmpt &, const direction) const

void	replace (const direction, const Cmpt &)

const ConstBlock< SubVector, BStart >	block () const

const VectorSpace< Vector< Cmpt >, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const

const Cmpt &	operator[] (const direction) const

Cmpt &	operator[] (const direction)

void	operator+= (const VectorSpace< Vector< Cmpt >, Cmpt, Ncmpts > &)

void	operator-= (const VectorSpace< Vector< Cmpt >, Cmpt, Ncmpts > &)

void	operator= (const Foam::zero)

void	operator*= (const Type)

void	operator/= (const Type)

Static Public Attributes
static const direction	rank = 1
	Rank of Vector is 1. More...

Static Public Attributes inherited from VectorSpace< Vector< Cmpt >, Cmpt, 3 >
static const direction	dim
	Dimensionality of space. More...

static const direction	nComponents
	Number of components in this vector space. More...

static const direction	mRows

static const direction	nCols

static const char *const	typeName

static const char *const	componentNames []

static const Vector< Cmpt >	zero

static const Vector< Cmpt >	one

static const Vector< Cmpt >	max

static const Vector< Cmpt >	min

static const Vector< Cmpt >	rootMax

static const Vector< Cmpt >	rootMin

static const Vector< Cmpt >	nan

Additional Inherited Members
Static Public Member Functions inherited from VectorSpace< Vector< Cmpt >, Cmpt, 3 >
static direction	size ()
	Return the number of elements in the VectorSpace = Ncmpts. More...

static Vector< Cmpt >	uniform (const Cmpt &s)
	Return a VectorSpace with all elements = s. More...

Public Attributes inherited from VectorSpace< Vector< Cmpt >, Cmpt, 3 >
Cmpt	v_ [Ncmpts]
	The components of this vector space. More...

Detailed Description

template<class Cmpt>
class Foam::Vector< Cmpt >

Templated 3D Vector derived from VectorSpace adding construction from 3 components, element access using x(), y() and z() member functions and the inner-product (dot-product) and cross product operators.

A centre() member function which returns the Vector for which it is called is defined so that point which is a typedef to Vector<scalar> behaves as other shapes in the shape hierarchy.

Source files

Definition at line 57 of file Vector.H.

Member Typedef Documentation

◆ labelType

typedef Vector<label> labelType

Equivalent type of labels used for valid component indexing.

Definition at line 65 of file Vector.H.

Member Enumeration Documentation

◆ components

enum components

Component labeling enumeration.

Enumerator
X
Y
Z

Definition at line 75 of file Vector.H.

Constructor & Destructor Documentation

◆ Vector() [1/5]

Vector

inline

Construct null.

Definition at line 29 of file VectorI.H.

◆ Vector() [2/5]

Vector ( const Foam::zero )

inline

Construct initialised to zero.

Definition at line 34 of file VectorI.H.

◆ Vector() [3/5]

Vector ( const VectorSpace< Vector< Cmpt2 >, Cmpt2, 3 > & vs )

inline

Construct given VectorSpace of the same rank.

Definition at line 42 of file VectorI.H.

◆ Vector() [4/5]

Vector	(	const Cmpt &	vx,
		const Cmpt &	vy,
		const Cmpt &	vz
	)

inline

Construct given three components.

Definition at line 52 of file VectorI.H.

References Y.

◆ Vector() [5/5]

Vector ( Istream & is )

inline

Construct from Istream.

Definition at line 66 of file VectorI.H.

Member Function Documentation

◆ x() [1/2]

const Cmpt & x

inline

Definition at line 75 of file VectorI.H.

Referenced by biLinearFitPolynomial::addCoeffs(), cubicUpwindFitPolynomial::addCoeffs(), linearFitPolynomial::addCoeffs(), quadraticFitPolynomial::addCoeffs(), quadraticLinearFitPolynomial::addCoeffs(), quadraticLinearUpwindFitPolynomial::addCoeffs(), quadraticUpwindFitPolynomial::addCoeffs(), triad::align(), plane::aPoint(), BarycentricTensor< Cmpt >::BarycentricTensor(), BarycentricTensor2D< Cmpt >::BarycentricTensor2D(), blockDescriptor::blockDescriptor(), treeBoundBox::calcExtremities(), CentredFitSnGradData< Polynomial >::calcFit(), rotorDisk::calculate(), boundBox::contains(), boundBox::containsInside(), cyclicPolyPatch::coupledEdges(), cyclicPolyPatch::coupledPoints(), treeBoundBox::distanceCmp(), Foam::eigenVectors(), pitchForkRing::energy(), treeBoundBox::extend(), treeBoundBox::faceBits(), Foam::faceNij(), Foam::facePoint(), Foam::facePointN(), dynamicTreeDataPoint::findNearest(), pitchForkRing::force(), rigidBodyModel::forwardDynamics(), geometric::geometric(), repatchMesh::getNearest(), waveSuperposition::height(), treeBoundBox::intersects(), Foam::inv(), Foam::isEven(), Rxyz::jcalc(), Ryxz::jcalc(), Rzyx::jcalc(), cellMDLimitedGrad< Type >::limitFace(), momentOfInertia::massPropertiesSolid(), boundBox::nearest(), twoDPointCorrector::normalDir(), Foam::operator&(), treeDataEdge::findNearestOp::operator()(), treeDataPoint::findNearestOp::operator()(), path::operator()(), Foam::operator*(), Foam::operator/(), Foam::operator^(), boundBox::overlaps(), plate::overlaps(), plane::planeIntersect(), polyTopoChange::pointRemoved(), tetrahedron< Point, PointRef >::pointToBarycentric(), treeBoundBox::posBits(), particle::prepareForNonConformalCyclicTransfer(), triad::primaryDirection(), quaternion::quaternion(), AC3DsurfaceFormat< Face >::read(), Foam::roundDown(), Foam::roundUp(), treeBoundBox::searchOrder(), Foam::setMinDimCells(), SpatialVector< Cmpt >::SpatialVector(), Foam::sqr(), Foam::triIntersect::srcEdgeTgtPointOffset(), treeBoundBox::subBbox(), treeBoundBox::subOctant(), surfaceDisplacementPointPatchVectorField::surfaceDisplacementPointPatchVectorField(), coordinateRotation::transformVectorDiagTensor(), pointConstraint::unconstrainedDirections(), joint::unitQuaternion(), waveSuperposition::velocity(), GTSsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), SMESHsurfaceFormat< Face >::write(), WRLsurfaceFormat< Face >::write(), X3DsurfaceFormat< Face >::write(), OBJstream::write(), VTKedgeFormat::writeHeader(), VTKsurfaceFormatCore::writeHeader(), coupledPolyPatch::writeOBJ(), treeBoundBox::writeOBJ(), triSurfaceTools::writeOBJ(), Foam::meshTools::writeOBJ(), cellCuts::writeOBJ(), and moleculeCloud::writeXYZ().

Here is the caller graph for this function:

◆ y() [1/2]

const Cmpt & y

inline

Definition at line 81 of file VectorI.H.

Referenced by biLinearFitPolynomial::addCoeffs(), cubicUpwindFitPolynomial::addCoeffs(), linearFitPolynomial::addCoeffs(), quadraticFitPolynomial::addCoeffs(), quadraticLinearFitPolynomial::addCoeffs(), quadraticLinearUpwindFitPolynomial::addCoeffs(), quadraticUpwindFitPolynomial::addCoeffs(), triad::align(), plane::aPoint(), BarycentricTensor< Cmpt >::BarycentricTensor(), BarycentricTensor2D< Cmpt >::BarycentricTensor2D(), blockDescriptor::blockDescriptor(), treeBoundBox::calcExtremities(), CentredFitSnGradData< Polynomial >::calcFit(), rotorDisk::calculate(), boundBox::contains(), boundBox::containsInside(), cyclicPolyPatch::coupledEdges(), cyclicPolyPatch::coupledPoints(), treeBoundBox::distanceCmp(), Foam::eigenVectors(), pitchForkRing::energy(), treeBoundBox::extend(), treeBoundBox::faceBits(), Foam::faceNij(), Foam::facePoint(), Foam::facePointN(), dynamicTreeDataPoint::findNearest(), pitchForkRing::force(), rigidBodyModel::forwardDynamics(), geometric::geometric(), repatchMesh::getNearest(), waveSuperposition::height(), treeBoundBox::intersects(), Foam::inv(), Foam::isEven(), Rxyz::jcalc(), Ryxz::jcalc(), Rzyx::jcalc(), cellMDLimitedGrad< Type >::limitFace(), momentOfInertia::massPropertiesSolid(), boundBox::nearest(), twoDPointCorrector::normalDir(), Foam::operator&(), treeDataEdge::findNearestOp::operator()(), treeDataPoint::findNearestOp::operator()(), Foam::operator*(), Foam::operator/(), Foam::operator^(), boundBox::overlaps(), plate::overlaps(), plane::planeIntersect(), polyTopoChange::pointRemoved(), tetrahedron< Point, PointRef >::pointToBarycentric(), treeBoundBox::posBits(), particle::prepareForNonConformalCyclicTransfer(), triad::primaryDirection(), quaternion::quaternion(), AC3DsurfaceFormat< Face >::read(), Foam::roundDown(), Foam::roundUp(), treeBoundBox::searchOrder(), Foam::setMinDimCells(), SpatialVector< Cmpt >::SpatialVector(), Foam::sqr(), Foam::triIntersect::srcEdgeTgtPointOffset(), treeBoundBox::subBbox(), treeBoundBox::subOctant(), surfaceDisplacementPointPatchVectorField::surfaceDisplacementPointPatchVectorField(), coordinateRotation::transformVectorDiagTensor(), pointConstraint::unconstrainedDirections(), joint::unitQuaternion(), waveSuperposition::velocity(), GTSsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), SMESHsurfaceFormat< Face >::write(), WRLsurfaceFormat< Face >::write(), X3DsurfaceFormat< Face >::write(), OBJstream::write(), VTKedgeFormat::writeHeader(), VTKsurfaceFormatCore::writeHeader(), coupledPolyPatch::writeOBJ(), treeBoundBox::writeOBJ(), triSurfaceTools::writeOBJ(), Foam::meshTools::writeOBJ(), cellCuts::writeOBJ(), and moleculeCloud::writeXYZ().

Here is the caller graph for this function:

◆ z() [1/2]

const Cmpt & z

inline

Definition at line 87 of file VectorI.H.

Referenced by biLinearFitPolynomial::addCoeffs(), cubicUpwindFitPolynomial::addCoeffs(), linearFitPolynomial::addCoeffs(), quadraticFitPolynomial::addCoeffs(), quadraticLinearFitPolynomial::addCoeffs(), quadraticLinearUpwindFitPolynomial::addCoeffs(), quadraticUpwindFitPolynomial::addCoeffs(), triad::align(), plane::aPoint(), BarycentricTensor< Cmpt >::BarycentricTensor(), BarycentricTensor2D< Cmpt >::BarycentricTensor2D(), blockDescriptor::blockDescriptor(), treeBoundBox::calcExtremities(), CentredFitSnGradData< Polynomial >::calcFit(), rotorDisk::calculate(), boundBox::containsInside(), cyclicPolyPatch::coupledEdges(), cyclicPolyPatch::coupledPoints(), treeBoundBox::distanceCmp(), Foam::eigenVectors(), pitchForkRing::energy(), treeBoundBox::extend(), treeBoundBox::faceBits(), Foam::faceNij(), Foam::facePoint(), Foam::facePointN(), dynamicTreeDataPoint::findNearest(), pitchForkRing::force(), rigidBodyModel::forwardDynamics(), geometric::geometric(), repatchMesh::getNearest(), waveSuperposition::height(), treeBoundBox::intersects(), Foam::inv(), Foam::isEven(), Rxyz::jcalc(), Ryxz::jcalc(), Rzyx::jcalc(), cellMDLimitedGrad< Type >::limitFace(), momentOfInertia::massPropertiesSolid(), boundBox::nearest(), twoDPointCorrector::normalDir(), Foam::operator&(), treeDataEdge::findNearestOp::operator()(), treeDataPoint::findNearestOp::operator()(), Foam::operator*(), Foam::operator/(), Foam::operator^(), boundBox::overlaps(), plate::overlaps(), plane::planeIntersect(), polyTopoChange::pointRemoved(), tetrahedron< Point, PointRef >::pointToBarycentric(), treeBoundBox::posBits(), particle::prepareForNonConformalCyclicTransfer(), triad::primaryDirection(), quaternion::quaternion(), AC3DsurfaceFormat< Face >::read(), Foam::roundDown(), Foam::roundUp(), treeBoundBox::searchOrder(), Foam::setMinDimCells(), SpatialVector< Cmpt >::SpatialVector(), Foam::sqr(), Foam::triIntersect::srcEdgeTgtPointOffset(), Foam::triIntersect::srcPointTgtEdgeOffset(), treeBoundBox::subBbox(), treeBoundBox::subOctant(), surfaceDisplacementPointPatchVectorField::surfaceDisplacementPointPatchVectorField(), coordinateRotation::transformVectorDiagTensor(), joint::unitQuaternion(), waveSuperposition::velocity(), GTSsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), SMESHsurfaceFormat< Face >::write(), WRLsurfaceFormat< Face >::write(), X3DsurfaceFormat< Face >::write(), OBJstream::write(), VTKedgeFormat::writeHeader(), VTKsurfaceFormatCore::writeHeader(), coupledPolyPatch::writeOBJ(), treeBoundBox::writeOBJ(), triSurfaceTools::writeOBJ(), Foam::meshTools::writeOBJ(), cellCuts::writeOBJ(), and moleculeCloud::writeXYZ().

Here is the caller graph for this function:

◆ x() [2/2]

Cmpt & x

inline

Definition at line 94 of file VectorI.H.

◆ y() [2/2]

Cmpt & y

inline

Definition at line 100 of file VectorI.H.

◆ z() [2/2]

Cmpt & z

inline

Definition at line 106 of file VectorI.H.

◆ centre()

const Foam::Vector< Cmpt > & centre ( const Foam::List< Vector< Cmpt >> & ) const

inline

Return *this (used for point which is a typedef to Vector<scalar>.

Definition at line 115 of file VectorI.H.

Referenced by cellShape::centre(), cyclicPolyPatch::coupledEdges(), and extendedEdgeMesh::sortPointsAndEdges().

Here is the caller graph for this function:

Member Data Documentation

◆ rank

const direction rank = 1

static

Rank of Vector is 1.

Definition at line 71 of file Vector.H.

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

src/OpenFOAM/primitives/Vector/Vector.H
src/OpenFOAM/primitives/Vector/VectorI.H

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

template<class Cmpt> class Foam::Vector< Cmpt >

Member Typedef Documentation

◆ labelType

Member Enumeration Documentation

◆ components

Constructor & Destructor Documentation

◆ Vector() [1/5]

◆ Vector() [2/5]

◆ Vector() [3/5]

◆ Vector() [4/5]

◆ Vector() [5/5]

Member Function Documentation

◆ x() [1/2]

◆ y() [1/2]

◆ z() [1/2]

◆ x() [2/2]

◆ y() [2/2]

◆ z() [2/2]

◆ centre()

Member Data Documentation

◆ rank

template<class Cmpt>
class Foam::Vector< Cmpt >