Solvers

Solvers is pretty cool.

class Solvers.AbstractField

Bases: matlab.mixin.Copyable

ABSTRACTFIELD Summary of this class goes here

Detailed explanation goes here

Property Summary
NZ

[-] Number of axial steps

NTIME

[-] Number of time steps

TIME

[s] Time series

DT

[s] Time step size

TIDX

[-] Time step index

Z

[m] Elevation

ITR

Iteration properties

flowProperties = {'W','U','H'}

Flow properties used for copying

Method Summary
memoizeFunction(methodStr, methodHandle, varargin)

MEMOIZEDMETHOD Implement a mechanism for registering memoizeable functions

For the first call with a particular method, create and memoize a function handle view of the method

struct()

STRUCT Converter to struct()

copyFlowProperties(srcObj, targetObj, opts)

COPYFLOWPROPERTIES

class Solvers.SolverPlotter(Titles, WallIdxs)

Bases: handle

SOLVERPLOTTER Framework for generating solver plots Detailed explanation goes here

Constructor Summary
SolverPlotter(Titles, WallIdxs)

SOLVERPLOTTER Construct an instance of this class Detailed explanation goes here

Property Summary
FontSize = 10

Font size of text in plots

Title = ""

Figure title

WallIdx = 1

Wall index

Grid = 'on'

Grid option

Method Summary
plotz(plotters, YData, fieldName, opts)

PLOTZ Summary of this method goes here Detailed explanation goes here

gca(plotters)

Loop through plotters

ylim(plotters, newLim)

Loop through plotters

setZs(plotters, Zs)

Loop through plotters

legend(plotters, varargin)

Loop through plotters

static fieldName2plotStyle(fieldName)

Default colors

class Solvers.SolverState

Bases: uint16

SOLVERSTATE Enumeration class of possible solver states

class Solvers.AbstractPhase

Bases: handle

ABSTRACTPHASE Summary of this class goes here Detailed explanation goes here

class Solvers.AbstractSolver(inputSet)

Bases: handle

ABSTRACTSOLVER Summary of this class goes here Detailed explanation goes here

Constructor Summary
AbstractSolver(inputSet)

ABSTRACTSOLVER Constructor

Property Summary
STATE

Solver state defined by SolverState enum

Method Summary
log(solver, varargin)

LOG Log events

static CreateITR(NZ, ITRFields)

Create inner iteration value struct

class Solvers.AbstractFilm(inputSet, fluid)

Bases: Solvers.AbstractField

ABSTRACTFILM Summary of this class goes here

Detailed explanation goes here

Constructor Summary
AbstractFilm(inputSet, fluid)

ABSFILM Creates an abstract film, absfilm

Detailed explanation goes here

Property Summary
DZ = 0

[m] Axial step size

Method Summary
WL(absfilm, zIdx)

WL() Film mass flow rate per unit perimeter

THICK(absfilm, zIdx)

THICK() Film thickness

RE(absfilm, zIdx)

RE() Film Reynolds number [-]

MENT(absfilm, zIdx)

MENT() Film entrainment mass flux

MTOT(absfilm, drop, zIdx)

MTOT() Total

CW(absfilm, zIdx)

CW() Wall friction factor

FWALL(absfilm, zIdx)

FWALL() Film wall shear stress

UWALL(absfilm, zIdx)

UWALL() [m/s] Film wall velocity

YPLUS2THICK(absfilm, yplus, zIdx)

YPLUS2THICK() Calculate thickness from wall unit value

CV(absfilm, zIdx)

CV() Film/vapor interfacial friction factor

FVAPOR(absfilm, zIdx)

FVAPOR() Film vapor shear stress

FBUOY(absfilm, zIdx)

FBUOY() Film buoyancy

FGRAV(absfilm, zIdx)

FGRAV() Film gravity

FDEP(absfilm, drop, zIdx)

FDEP() Drop deposition shear

FTOT(absfilm, drop, zIdx)

FTOT() Total

UALGEBR(absfilm, zIdx)

UALGEBR() Film velocity based on simple algebraic model

UEQUILS(absfilm, zIdx)

UEQUILS() Film velocity based on simple equilibrium model (Fwall + Fvapor = 0)

UEQUIL(absfilm, drop, zIdx)

UEQUIL() Film velocity based on complete equilibrium model (Ftot = 0)