CubbyFlow::FDMBLAS3 Struct Reference

BLAS operator wrapper for 3-D finite differencing. More...

#include <Core/FDM/FDMLinearSystem3.h>

Public Types
using	ScalarType = double
using	VectorType = FDMVector3
using	MatrixType = FDMMatrix3

Static Public Member Functions
static void	Set (ScalarType s, VectorType *result)
	Sets entire element of given vector result with scalar s. More...
static void	Set (const VectorType &v, VectorType *result)
	Copies entire element of given vector result with other vector v. More...
static void	Set (ScalarType s, MatrixType *result)
	Sets entire element of given matrix result with scalar s. More...
static void	Set (const MatrixType &m, MatrixType *result)
	Copies entire element of given matrix result with other matrix v. More...
static double	Dot (const VectorType &a, const VectorType &b)
	Performs dot product with vector a and b. More...
static void	AXPlusY (double a, const VectorType &x, const VectorType &y, VectorType *result)
	Performs ax + y operation where a is a matrix and x and y are vectors. More...
static void	MVM (const MatrixType &m, const VectorType &v, VectorType *result)
	Performs matrix-vector multiplication. More...
static void	Residual (const MatrixType &a, const VectorType &x, const VectorType &b, VectorType *result)
	Computes residual vector (b - ax). More...
static ScalarType	L2Norm (const VectorType &v)
	Returns L2-norm of the given vector v. More...
static ScalarType	LInfNorm (const VectorType &v)
	Returns Linf-norm of the given vector v. More...

Detailed Description

BLAS operator wrapper for 3-D finite differencing.

Member Typedef Documentation

MatrixType

using CubbyFlow::FDMBLAS3::MatrixType = FDMMatrix3

ScalarType

using CubbyFlow::FDMBLAS3::ScalarType = double

VectorType

using CubbyFlow::FDMBLAS3::VectorType = FDMVector3

Member Function Documentation

AXPlusY()

static void CubbyFlow::FDMBLAS3::AXPlusY ( double  a, const VectorType &  x, const VectorType &  y, VectorType *  result  )

static

Performs ax + y operation where a is a matrix and x and y are vectors.

Dot()

static double CubbyFlow::FDMBLAS3::Dot ( const VectorType &  a, const VectorType &  b  )

static

Performs dot product with vector a and b.

L2Norm()

static ScalarType CubbyFlow::FDMBLAS3::L2Norm ( const VectorType &  v )

static

Returns L2-norm of the given vector v.

LInfNorm()

static ScalarType CubbyFlow::FDMBLAS3::LInfNorm ( const VectorType &  v )

static

Returns Linf-norm of the given vector v.

MVM()

static void CubbyFlow::FDMBLAS3::MVM ( const MatrixType &  m, const VectorType &  v, VectorType *  result  )

static

Performs matrix-vector multiplication.

Residual()

static void CubbyFlow::FDMBLAS3::Residual ( const MatrixType &  a, const VectorType &  x, const VectorType &  b, VectorType *  result  )

static

Computes residual vector (b - ax).

Set() [1/4]

static void CubbyFlow::FDMBLAS3::Set ( ScalarType  s, VectorType *  result  )

static

Sets entire element of given vector result with scalar s.

Set() [2/4]

static void CubbyFlow::FDMBLAS3::Set ( const VectorType &  v, VectorType *  result  )

static

Copies entire element of given vector result with other vector v.

Set() [3/4]

static void CubbyFlow::FDMBLAS3::Set ( ScalarType  s, MatrixType *  result  )

static

Sets entire element of given matrix result with scalar s.

Set() [4/4]

static void CubbyFlow::FDMBLAS3::Set ( const MatrixType &  m, MatrixType *  result  )

static

Copies entire element of given matrix result with other matrix v.

---

The documentation for this struct was generated from the following file:

• Core/FDM/FDMLinearSystem3.h