TransFlow  0.1.0
A transient pipeline flow simulation library
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
 Ndetails
 CPropertyToSampleThe PropertyToSample struct contains information about a single property from Pipeline that we are going to sample
 Nutils
 Clinalg_error
 CLinearInterpolator
 Cno_convergence_error
 Cno_solution_found
 Cphysics_error
 Cpressure_range_error
 Cstringbuilder
 Ctemperature_range_error
 CAmbientFluidSimple container class that defines the conductivity, density, heat capacity, dynamic viscosity and velocity of a fluid used by HeatTransfer
 CBatchTrackingA class for calculating the time development of the gas composition from the gas velocity
 CBatchTrackingStateContains the state which BatchTracking operates on
 CBatchContains the information for a single batch
 CBoundaryConditionsContainer for the boundary conditions at the inlet and outlet of a pipeline, for a single time step
 CSingleConditionUsed to store a single boundary condition (like flow, pressure or temperature), and also contains information on whether the condition is "active", meaning if it is meant to be a constrain when solving the governing equations
 CBurialMediumSimple container class that defines the conductivity, density and heat capacity of a burial medium. Mostly used by HeatTransfer
 CBWRSImplements the Benedict-Webb-Rubin-Starling (BWRS) equation of state
 CCompositionSimple container class for the composition of natural gas. We use arma::vec::fixed<10> to fix the number of components at 10
 CConfigThe Config struct stores all settings for the different parts of the pipeline simulation
 CDiscretizerDiscretizer is an abstract class, the base class the implementation of the discretization of the two different sets of governing equations; internal energy and enthalpy
 CDummyGasDummy EOS implementation used for unit testing. This uses a special molar mass for the gas components, which makes for easier testing
 CEnthalpyDiscretizerImplementation of Discretizer for the enthalpy form of the energy equation
 CEquationOfStateWrapper around EquationOfStateBase that has one equation of state instance per grid point, and wraps the EquationOfStateBase::evaluate() function
 CEquationOfStateBaseThe EquationOfStateBase is an abstract class, the base class for different equations of state
 CFixedQValueImplementation of HeatTransferBase for fixed heat flux
 CFixedUValueImplementation of HeatTransferBase for fixed U-value (total heat transfer coefficient)
 CGERG04Implements the GERG 2004 equation of state
 CGoverningEquationSolverThe GoverningEquationSolver class is a composition of Discretizer and MatrixEquation with a little bit of logic, that solves the governing equations for a 1d gas pipeline
 CGoverningEquationSolverBaseSimple Base class to avoid having to specify template argument for GoverningEquationSolver. This means that we have to use pointers to GoverningEquationSolverBase instead of simple GoverningEquationSolverBase instances
 CHeatTransferThe EquationOfState class is a wrapper around HeatTransferBase that has one heat transfer instance per grid point, and wraps the HeatTransferBase::evaluate() function
 CHeatTransferBaseAbstract class, the base class for all heat transfer implementations. It mostly just defines a stencil for the evaluate() function and the HeatTransferState class
 CHeatTransferStateContainer for the state of a HeatTransferBase instance. All HeatTransferBase subclasses operate on instances of State, and return State
 CIdealGasImplements the equation of state for an ideal gas
 CInternalEnergyDiscretizerImplementation of Discretizer for the internal energy form of the energy equation
 CMaterialSimple container class that defines the conductivity, density and heat capacity of a material
 CMatrixEquationSets up the matrix equation from the system of equations found from the governing equations
 CPhysicsCombines EquationOfState and HeatTransfer to calculate the new state of a pipeline given a new pressure, temperature and flow
 CPipeline
 CState
 CPipeWallContainer class that defines the thickness and Material properties of each layer a pipe consists of
 CLayerThe PipeWall::Layer class is a simple container class that defines the thickness and all other material properties of a single layer of pipe wall
 CRadialHeatTransferBase class for heat transfer calculation with 1d radial models
 CSamplerUsed to sample selected Pipeline properties during simulations
 CSimulatorCombines Physics and Solver to advance the state of the pipeline in time. It contains a Pipeline instance which has thes state of the pipeline at all times
 CSolverCombines GoverningEquationSolver and BatchTracking to advance the governing equations forward in time, and advect the gas composition
 CSteadyStateHeatTransferClass that implements steady state heat transfer between gas and pipeline surroundings
 CTimeSeriesUsed to store the boundary conditions for several time steps
 CSeries
 CTimeStepSubclass of BoundaryConditions with an extra member to store the timestamp of the boundary conditions
 CUnsteadyHeatTransferImplements 1d radial unsteady heat transfer