SheafSystem  0.0.0.0
Functions
fields::field_vd_algebra Namespace Reference

Namespace containing the algrebra functions for a field with a property section of type sec_vd. More...

Functions

SHEAF_DLL_SPEC void add (const field_vd &x0, const field_vd &x1, field_vd &xresult, bool xauto_access)
 x0 add x1 (pre-allocated version). More...
 
SHEAF_DLL_SPEC void add_equal (field_vd &xresult, const field_vd &xother, bool xauto_access)
 x0 add_equal x1 (self-allocated version); synonym for add(xresult, xother, xresult, xauto_access). More...
 
SHEAF_DLL_SPEC void subtract (const field_vd &x0, const field_vd &x1, field_vd &xresult, bool xauto_access)
 x0 subtract x1 (pre-allocated version). More...
 
SHEAF_DLL_SPEC void subtract_equal (field_vd &xresult, const field_vd &xother, bool xauto_access)
 x0 subtract_equal x1 (self-allocated version); synonym for subtract(xresult, xother, xresult, xauto_access). More...
 
SHEAF_DLL_SPEC void multiply (const field_vd &x0, const sec_at0 &x1, field_vd &xresult, bool xauto_access)
 x0 multiplied by x1 (pre-allocated version). More...
 
SHEAF_DLL_SPEC void multiply_equal (field_vd &xresult, const sec_at0 &xother, bool xauto_access)
 xresult multiply_equal xresult (pre-allocated version); synonym for multiply(xresult, xother, xresult, xauto_access). More...
 
SHEAF_DLL_SPEC void multiply (const field_vd &x0, const vd_value_type &x1, field_vd &xresult, bool xauto_access)
 x0 multiplied by x1 (a constant) (pre-allocated version). More...
 
SHEAF_DLL_SPEC void multiply_equal (field_vd &xresult, const vd_value_type &xother, bool xauto_access)
 xresult multiply_equal xother (pre-allocated version); synonym for multiply(xresult, xother, xresult, xauto_access). More...
 
SHEAF_DLL_SPEC void divide (const field_vd &x0, const sec_at0 &x1, field_vd &xresult, bool xauto_access)
 x0 divided by x1 (pre-allocated version). More...
 
SHEAF_DLL_SPEC void divide_equal (field_vd &xresult, const sec_at0 &xother, bool xauto_access)
 xresult divide_equal xother (pre-allocated version); synonym for divide(xresult, xother, xresult, xauto_access). More...
 
SHEAF_DLL_SPEC void divide (const field_vd &x0, const vd_value_type &x1, field_vd &xresult, bool xauto_access)
 x0 divided by x1 (a constant) (pre-allocated version). More...
 
SHEAF_DLL_SPEC void divide_equal (field_vd &xresult, const vd_value_type &xother, bool xauto_access)
 xresult divide_equal xother (pre-allocated version); synonym for divide(xresult, xother, xresult, xauto_access). More...
 
SHEAF_DLL_SPEC void contract (const field_vd &xvector, const field_vd &xcovector, field_at0 &xresult, bool xauto_access)
 Contraction of vector xvector on covector xcovector (pre-allocated version). More...
 

Detailed Description

Namespace containing the algrebra functions for a field with a property section of type sec_vd.

Function Documentation

◆ add()

void fields::field_vd_algebra::add ( const field_vd &  x0,
const field_vd &  x1,
field_vd &  xresult,
bool  xauto_access 
)

x0 add x1 (pre-allocated version).

Implementation for field_vd algebra functions.

Precondition
  • precondition_of(\ add(x0.property(), x1.property(), xresult.property(), xauto_access))
Postcondition
  • postcondition_of(\ add(x0.property(), x1.property(), xresult.property(), xauto_access))

Definition at line 32 of file field_vd_funcs.impl.h.

References fiber_bundle::sec_vd_algebra::add(), fiber_bundle::vd_algebra::add(), add_equal(), and fields::field_vd::property().

◆ add_equal()

void fields::field_vd_algebra::add_equal ( field_vd &  xresult,
const field_vd &  xother,
bool  xauto_access 
)

x0 add_equal x1 (self-allocated version); synonym for add(xresult, xother, xresult, xauto_access).

Precondition
  • precondition_of(add(xresult, xother, xresult, xauto_access))
Postcondition
  • postcondition_of(add(xresult, xother, xresult, xauto_access))

Definition at line 57 of file field_vd_funcs.impl.h.

References fiber_bundle::vd_algebra::add(), and subtract().

Referenced by add().

◆ contract()

void fields::field_vd_algebra::contract ( const field_vd &  xvector,
const field_vd &  xcovector,
field_at0 &  xresult,
bool  xauto_access 
)

Contraction of vector xvector on covector xcovector (pre-allocated version).

Precondition
  • precondition_of(\ contract(xvector.property(), xcovector.property(),\ xresult.property(), xauto_access))
Postcondition
  • postcondition_of(\ contract(xvector.property(), xcovector.property(),\ xresult.property(), xauto_access))

Definition at line 314 of file field_vd_funcs.impl.h.

References fiber_bundle::tp_algebra::contract(), fiber_bundle::sec_vd_algebra::contract(), fields::field_at0::property(), and fields::field_vd::property().

Referenced by divide_equal().

◆ divide() [1/2]

void fields::field_vd_algebra::divide ( const field_vd &  x0,
const sec_at0 &  x1,
field_vd &  xresult,
bool  xauto_access 
)

x0 divided by x1 (pre-allocated version).

Precondition
  • precondition_of(\ divide(x0.property(), x1, xresult.property(), xauto_access))
Postcondition
  • postcondition_of(\ divide(x0.property(), x1, xresult.property(), xauto_access))

Definition at line 220 of file field_vd_funcs.impl.h.

References fiber_bundle::sec_vd_algebra::divide(), fiber_bundle::vd_algebra::divide(), divide_equal(), and fields::field_vd::property().

Referenced by divide_equal(), and multiply_equal().

◆ divide() [2/2]

void fields::field_vd_algebra::divide ( const field_vd &  x0,
const vd_value_type &  x1,
field_vd &  xresult,
bool  xauto_access 
)

x0 divided by x1 (a constant) (pre-allocated version).

Precondition
  • precondition_of(\ divide(x0.property(), x1, xresult.property(), xauto_access))
Postcondition
  • postcondition_of(\ divide(x0.property(), x1, xresult.property(), xauto_access))

Definition at line 267 of file field_vd_funcs.impl.h.

References fiber_bundle::sec_vd_algebra::divide(), fiber_bundle::vd_algebra::divide(), divide_equal(), and fields::field_vd::property().

◆ divide_equal() [1/2]

void fields::field_vd_algebra::divide_equal ( field_vd &  xresult,
const sec_at0 &  xother,
bool  xauto_access 
)

xresult divide_equal xother (pre-allocated version); synonym for divide(xresult, xother, xresult, xauto_access).

Precondition
  • precondition_of(divide(xresult, xother, xresult, xauto_access))
Postcondition
  • postcondition_of(divide(xresult, xother, xresult, xauto_access))

Definition at line 245 of file field_vd_funcs.impl.h.

References divide(), and fiber_bundle::vd_algebra::divide().

Referenced by divide().

◆ divide_equal() [2/2]

void fields::field_vd_algebra::divide_equal ( field_vd &  xresult,
const vd_value_type &  xother,
bool  xauto_access 
)

xresult divide_equal xother (pre-allocated version); synonym for divide(xresult, xother, xresult, xauto_access).

Precondition
  • precondition_of(divide(xresult, xother, xresult, xauto_access))
Postcondition
  • postcondition_of(divide(xresult, xother, xresult, xauto_access))

Definition at line 292 of file field_vd_funcs.impl.h.

References contract(), and fiber_bundle::vd_algebra::divide().

◆ multiply() [1/2]

void fields::field_vd_algebra::multiply ( const field_vd &  x0,
const sec_at0 &  x1,
field_vd &  xresult,
bool  xauto_access 
)

x0 multiplied by x1 (pre-allocated version).

Precondition
  • precondition_of(\ multiply(x0.property(), x1, xresult.property(), xauto_access))
Postcondition
  • postcondition_of(\ multiply(x0.property(), x1, xresult.property(), xauto_access))

Definition at line 126 of file field_vd_funcs.impl.h.

References fiber_bundle::sec_vd_algebra::multiply(), fiber_bundle::vd_algebra::multiply(), multiply_equal(), and fields::field_vd::property().

Referenced by multiply_equal(), and subtract_equal().

◆ multiply() [2/2]

void fields::field_vd_algebra::multiply ( const field_vd &  x0,
const vd_value_type &  x1,
field_vd &  xresult,
bool  xauto_access 
)

x0 multiplied by x1 (a constant) (pre-allocated version).

Precondition
  • precondition_of(\ multiply(x0.property(), x1, xresult.property(), xauto_access))
Postcondition
  • postcondition_of(\ multiply(x0.property(), x1, xresult.property(), xauto_access))

Definition at line 173 of file field_vd_funcs.impl.h.

References fiber_bundle::sec_vd_algebra::multiply(), fiber_bundle::vd_algebra::multiply(), multiply_equal(), and fields::field_vd::property().

◆ multiply_equal() [1/2]

void fields::field_vd_algebra::multiply_equal ( field_vd &  xresult,
const sec_at0 &  xother,
bool  xauto_access 
)

xresult multiply_equal xresult (pre-allocated version); synonym for multiply(xresult, xother, xresult, xauto_access).

Precondition
  • precondition_of(multiply(xresult, xother, xresult, xauto_access))
Postcondition
  • postcondition_of(multiply(xresult, xother, xresult, xauto_access))

Definition at line 151 of file field_vd_funcs.impl.h.

References multiply(), and fiber_bundle::vd_algebra::multiply().

Referenced by multiply().

◆ multiply_equal() [2/2]

void fields::field_vd_algebra::multiply_equal ( field_vd &  xresult,
const vd_value_type &  xother,
bool  xauto_access 
)

xresult multiply_equal xother (pre-allocated version); synonym for multiply(xresult, xother, xresult, xauto_access).

Precondition
  • precondition_of(multiply(xresult, xother, xresult, xauto_access))
Postcondition
  • postcondition_of(multiply(xresult, xother, xresult, xauto_access))

Definition at line 198 of file field_vd_funcs.impl.h.

References divide(), and fiber_bundle::vd_algebra::multiply().

◆ subtract()

void fields::field_vd_algebra::subtract ( const field_vd &  x0,
const field_vd &  x1,
field_vd &  xresult,
bool  xauto_access 
)

x0 subtract x1 (pre-allocated version).

Precondition
  • precondition_of(\ subtract(x0.property(), x1.property(), xresult.property(), xauto_access))
Postcondition
  • postcondition_of(\ subtract(x0.property(), x1.property(), xresult.property(), xauto_access))

Definition at line 79 of file field_vd_funcs.impl.h.

References fields::field_vd::property(), fiber_bundle::sec_vd_algebra::subtract(), fiber_bundle::vd_algebra::subtract(), and subtract_equal().

Referenced by add_equal().

◆ subtract_equal()

void fields::field_vd_algebra::subtract_equal ( field_vd &  xresult,
const field_vd &  xother,
bool  xauto_access 
)

x0 subtract_equal x1 (self-allocated version); synonym for subtract(xresult, xother, xresult, xauto_access).

Precondition
  • precondition_of(subtract(xresult, xother, xresult, xauto_access))
Postcondition
  • postcondition_of(subtract(xresult, xother, xresult, xauto_access))

Definition at line 104 of file field_vd_funcs.impl.h.

References multiply(), and fiber_bundle::vd_algebra::subtract().

Referenced by subtract().