GitHub

Quantities

The concept of quantities is implemented on top of the concept of species numbers. They have been introduces in order to be able to handle discontinuities at interfaces.

VoronoiFVM.ContinuousQuantity — Type
struct ContinuousQuantity{Ti} <: VoronoiFVM.AbstractQuantity{Ti}

A continuous quantity is represented by exactly one species number

  • ispec::Any: Species number representing the quantity
  • id::Any: Quantity identifier allowing to use the quantity as index in parameter fields
source
VoronoiFVM.ContinuousQuantity — Method
 ContinuousQuantity(system,regions; ispec=0, id=0)

Add continuous quantity to the regions listed in regions.

Unless specified in ispec, the species number is generated automatically.

Unless specified by id, the quantity ID is generated automatically.

source
VoronoiFVM.DiscontinuousQuantity — Type
struct DiscontinuousQuantity{Ti} <: VoronoiFVM.AbstractQuantity{Ti}

A discontinuous quantity is represented by different species in neighboring regions.

  • regionspec::Vector: Species numbers representing the quantity in each region
  • id::Any: Quantity identifier allowing to use the quantity as index in parameter fields
source
VoronoiFVM.DiscontinuousQuantity — Method
 DiscontinuousQuantity(system,regions; regionspec=nothing, id=0)

Add discontinuous quantity to the regions listed in regions.

Unless specified in regionspec, the species numbers for each region are generated automatically.

Unless specified by id, the quantity ID is generated automatically.

source
VoronoiFVM.InterfaceQuantity — Type
struct InterfaceQuantity{Ti} <: VoronoiFVM.AbstractQuantity{Ti}

An interface quantity is represented by exactly one species number

  • ispec::Any: Species number representing the quantity
  • bregspec::Vector: boundary regions, where interface quantity is defined
  • id::Any: Quantity identifier allowing to use the quantity as index in parameter fields
source
VoronoiFVM.InterfaceQuantity — Method
 InterfaceQuantity(system,regions; ispec=0, id=0)

Add interface quantity to the boundary regions given in breg.

Unless specified in ispec, the species number is generated automatically.

Unless specified by id, the quantity ID is generated automatically.

source
Base.getindex — Method
A[q]

Access columns of vectors A using id of quantity q. This is meant for vectors indexed by species.

source
Base.getindex — Method
M[q,i]

Access columns M using id of quantity q. This is meant for nspecies x nregions matrices e.g. defining parameters.

source
Base.getindex — Method
bnode[quantity,ireg]

Return species number of discontinuous quantity region ireg adjacent to BNode.

source
Base.getindex — Method
bnode[quantity]

Return species number of discontinuous quantity region ireg adjacent to BNode for outer boundary nodes.

source
Base.getindex — Method
u[q,j]

Return value of quantity in unknowns on edge in flux callbacks.

source
Base.getindex — Method
u[q]

Return value of quantity in unknowns on node in node callbacks.

source
Base.getindex — Method
u[q,ireg]

Return value of discontinuous quantity in unknowns adjacent to unknowns on boundary node.

source
Base.setindex! — Method
A[q]

Set element of A using id of quantity q This is meant for vectors indexed by species.

source
Base.setindex! — Method
M[q,i]

Set element of M using id of quantity q. This is meant for nspecies x nregions matrices e.g. defining parameters.

source
Base.setindex! — Method
f[q,ireg]=v

Set rhs value for discontinuous quantity in adjacent regions of boundary node.

source
VoronoiFVM.subgrids — Method
subgrids(quantity, system)

Return a vector of subgrids containing a subgrid for each region where discontinuous quantity is defined.

source
VoronoiFVM.views — Method
views(quantity, subgrids,system)

Return a vector of solutions containing the solutions with respect tp each region where discontinuous quantity is defined.

source