Common operations 3D vectors.

Implementation is in header file for better optimisaition. More...

Functions
static void	forcefields::PotentialBase::divide (double v[], double const divisor)
	Divide vector.
static double *	forcefields::PotentialBase::crossProduct (const double v[], const double w[], double e[])
	Cross product.
static double	forcefields::PotentialBase::dotProduct (double const v[], double const w[])
	Dot product.
static void	forcefields::PotentialBase::multiply (double v[], double const factor)
	Multiply vector.
static double	forcefields::PotentialBase::norm (double const v[])
	Norm of 3D vector.
static void	forcefields::PotentialBase::normalise (double v[])
	Normalise 3D vector \( \frac{\mathbf v}{ |\mathbf v|} \).

Detailed Description

Implementation is in header file for better optimisaition.

Function Documentation

crossProduct()

double * forcefields::PotentialBase::crossProduct ( const double v[], const double w[], double e[] )

inlinestaticprotected

Cross product.

\( \mathbf e=\mathbf v \times \mathbf w \)

Parameters

[in]	v	3D vector.
[in]	w	3D vector.
[out]	e	Result.

Definition at line 192 of file potential_base.hpp.

                                                                               {
  e[0] = v[1] * w[2] - v[2] * w[1];
  e[1] = v[2] * w[0] - v[0] * w[2];
  e[2] = v[0] * w[1] - v[1] * w[0];
  return e;
}

divide()

void forcefields::PotentialBase::divide ( double v[], double const divisor )

inlinestaticprotected

Divide vector.

Parameters

[in,out]	v	Three-dimension vector to divide.
[in]	divisor	Divide v by divisor.

Definition at line 204 of file potential_base.hpp.

                                                                      {
  v[0] /= divisor;
  v[1] /= divisor;
  v[2] /= divisor;
}

dotProduct()

double forcefields::PotentialBase::dotProduct ( double const v[], double const w[] )

inlinestaticprotected

Dot product.

\( \mathbf v . \mathbf w \)

Parameters

[in]	v	3D vector.
[in]	w	3D vector.

Returns

Dot product.

Definition at line 216 of file potential_base.hpp.

                                                                {
  return v[0] * w[0] + v[1] * w[1] + v[2] * w[2];
}

multiply()

void forcefields::PotentialBase::multiply ( double v[], double const factor )

inlinestaticprotected

Multiply vector.

Parameters

[in,out]	v	Three-dimension vector to multiply.
[in]	factor	Multiply v by factor.

Definition at line 225 of file potential_base.hpp.

                                                                       {
  v[0] *= factor;
  v[1] *= factor;
  v[2] *= factor;
}

norm()

double forcefields::PotentialBase::norm ( double const v[] )

inlinestaticprotected

Norm of 3D vector.

\( |\mathbf v| \)

Parameters

[in]

v

3D vector.

Returns

Norm.

Definition at line 236 of file potential_base.hpp.

                                                      {
  return sqrt(dotProduct(v, v));
}

normalise()

void forcefields::PotentialBase::normalise ( double v[] )

inlinestaticprotected

Normalise 3D vector \( \frac{\mathbf v}{ |\mathbf v|} \).

Parameters

[in,out]

v

3D vector to normalise.

Definition at line 244 of file potential_base.hpp.

                                                   {
  double const n = norm(v);
  divide(v, n);
}