modelRegion

Base model for a 3D array of subregions

Information

If Lx is an empty vector (e.g., zeros(0), ones(0), or fill(1, 0)), then there are no subregions along the x axis and the boundaries along the x axis are directly connected. The same applies to the other axes.

Parameters

TypeNameDefaultDescription
Integern_xsize(L_x, 1)Number of sets of subregions along the x axis
Integern_ysize(L_y, 1)Number of sets of subregions along the y axis
Integern_zsize(L_z, 1)Number of sets of subregions along the z axis
Q.Length[Axis]L{sum(L_x), sum(L_y), sum(L_z)}Length
Q.Area[Axis]A{L[cartWrap(axis + 1)]*L[cartWrap(axis + 2)] for axis in Axis}Cross-sectional areas
Q.VolumeVproduct(L)Volume
Geometry
Q.Length[:]L_x{U.cm}Lengths along the x axis
Q.Length[:]L_y{U.cm}Lengths along the y axis
Q.Length[:]L_z{U.cm}Lengths across the z axis
Assumptions › Included transport axes
BooleaninclTransXtrueX
BooleaninclTransYtrueY
BooleaninclTransZtrueZ

Connectors

TypeNameDefaultDescription
Connectors.BoundaryBus[n_y,n_z]xNegativeNegative boundary along the x axis
Connectors.BoundaryBus[n_y,n_z]xPositivePositive boundary along the x axis
Connectors.BoundaryBus[n_x,n_z]yNegativeNegative boundary along the y axis
Connectors.BoundaryBus[n_x,n_z]yPositivePositive boundary along the y axis
Connectors.BoundaryBus[n_x,n_y]zNegativeNegative boundary along the z axis
Connectors.BoundaryBus[n_x,n_y]zPositivePositive boundary along the z axis

Components

TypeNameDefaultDescription
Subregion[n_x,n_y,n_z]subregionsInstances of the subregion model

Contents

NameDescription
Subregion