 |
DamBreak++ Wave Simulator 0.3
DamBreak++ Simulation Framework
|
|
DamBreak++ Wave Simulator 0.3
DamBreak++ Simulation Framework
|
| Ndbpp | |
| CcallCounter | Generic class that wraps and counts calls of an arbitrary callback |
| CCell | Cell concept is at the heart of the finite volume discretization. Usage: Reconstruction procedure based on MUSCL (UL,UR at each face) MusclReconstruction w_muscl(); w_muscl.reconstr(GlobalDisretization aGDiscr); // based on cell face global Id retrieve a cell to perform some operation std::map<unsigned shortglobal cell face Id,fluxpairFL,FR> w_fluxFace; list<cell> w_listOfCell; for(Cell w_cell : w_listOfCell) { Create a flux algorithm FluxAlgorithm w_fluxAlgo; |
| CcellFace | Cell face in the finite volume discretization Usage: caculFF(const cellFace& aFace) compute the numerical flux with Godunov-type scheme for example F(UL,UR) with Approximate Riemann Solver (discontinuity or shock represented by cell face) |
| CcellFaceFlux | Face flux variables at cell face (aggregate). Physical flux is used to compute the face flux .. |
| CDamBreakProblem | The DAM-BREAK Problem class is a model of a well-posed problem |
| CDamBreakWaveSimulator | Abstract class that serve as base class intending to implement dam break wave simulator |
| CEMcNeilPhysBC | Physical boundary (characteristic equation solved) |
| CFileDataStore | Specify the DataStore file (save simulation results) |
| CFiniteDifferenceModel | "Model of Explicit scheme with time integration algorithm. Finite difference model a numerical representation of the math equations |
| CFiniteVolumeDiscretization | Global discretized domain is defined as a set of all nodes and all elements. PHYSICAL ENTITIES include nodes and elements Node <-— Cell; i.e., element depends on node Omega = { all Node, all Cell }; global discretized domain is defined as a set of all nodes and all elements |
| CFirstDerivative | Compute first derivative at second-order (finite difference) |
| CFluxAlgorithm | Abstract base class for numerical flux algorithm |
| CFluxTensor | Flux tensor field (aggregate initialization) |
| CFluxTensorMap | Map cell face and flux values |
| CGamma | Boundary condition |
| CGodunovTypeScheme | Abstract base class for Godunov-type scheme (Model of). This is a model of an explicit scheme U_i = U_i - lambda*{F (UL_i+1/2,UR_i+1/2) - F(UL_i-1/2, UR_i-1/2) } Numerical representation of the mathematical model equivalent of conservation system law () |
| CHLLFlux1D | "Model of" F_j +/- 1/2 numerical scheme at the cell interface. This class represents the HLL (Harten-Lax-Leer) solving algorithm (based on Riemann approximate solver) |
| CHLLFluxAlgorithm | Numerical flux algorithm based on HLL (Harten-Lax_Levy) |
| CHLLParameterStruct | Algorithm parameters HLL Algorithm |
| CHLLPhysicalFlux | |
| CHLLSolver1D | Riemann solver that belongs to Approximate Riemann solver. Solve the Riemann problem at cell Face. Riemann problem u want to set which is made of discontinuity and state vector (left/right) Shall return a map with key = cellFaceID and value is flux face (FF1,FF2) |
| CisHomogeneous | Check if types are identical using fold expression |
| CListSectionsFlow | List of cross-section flow (itereable) |
| CManningFormula | Manning formula (friction law) Sf = g*n1*n1*V1*::fabs(V1)/A*A::pow(R1, 4./3.); |
| CMinMod19 | Minmod limiter function for slope limiting gradient evaluation |
| CMUSCLReconstr | |
| CNodalTpl | Implementation for nodal variable concept used in our application (use of variadic template) |
| CNujicFluxAlgorithm | Numerical flux algorithm based on Nujic (1995) paper. ENO type scheme (Roe simplified version) |
| CNujicIntegrator | Belongs two-step integrator Runge-Kutta family |
| CNumericalMethod | Mapping between continuum and discrete domain. Transformation of the differential or integral equations to discrete algebraic equations involving the values of the unknowns at the mesh points. The basis of all numerical methods consists of this transformation of the physical euations into an algebraic, linear or non-linear, systems of equations |
| CODESolver1D | Base class ODE Solver (under construction) |
| COmega | Global Domain (part of global discretization) list of elements and geomeric nodes used by numerical method |
| CPhysicalBoundaryCnd | Physical boundary condition (computational domain) based on characteristic equation .. |
| CPhysicalMeasurement | Measure taken on the physical system (defines the required method for the Measurement bean). Still under development, physical state variables are the only measured quantities relevant for this simulation. we may be interested by energy slope, ... any other physics qty |
| CPhysicalSystem | Physical system made of physical objects under study and described by the state variables. DamBreak physical system, physical objects are cross-sectional flow. Dynamic equations that describe the movement of the flow of water under gravity law, pressure and friction are described by the St-Venant set of equations. In conservative form mass and momentum are the quantity conserved across each section (state variables) |
| CPtr2FLegacyFluxAlgorithm | Numerical Face Flux Algorithm (Legacy code support Pointer-2-Function) |
| CRhsHLLFluxSrc | Physics algorithm based on Nujic paper (1995), but use HLL (Harten-Lax-van Leer) for convective flux solver (E. McNeil) |
| CRhsPtr2FuncFlux | Wrappper class to support legacy code (C-functions) |
| CRiemannProblem | System of conservation Law with an initial discontinuity in it. Two states connected by a left and right state which can be represented constant piecewise function over each cell where shock propagate (a cell face define a discontinuity) |
| CRk2HllScheme | Algorithm based on the Godunov-type Scheme (explicit). We use a two-time steps integrator belongs to Runge-Kutta family and the HLL algorithm for convective flux evaluation. Order is achieved by MUSCL reconstruction procedure to extrapolate state variables at cell face j+1/2 (piecewise-constant state variable on each cell). This algorithm solve at cell-face a Riemann problem (system of conservation law coupled with 2-state tied by a discontinuity define a Riemann Problem) |
| CSectionFlow | Cross-sectional flow (2-dimensional) |
| CSemiDiscreteMethod | MOL (Method-of-lines) spatial and time discretization done separetly. Model of the following equation (ODE) U_t = L_delta(U;t); where L_delta (spatial operator) contains derivative of some variable and describe the evolution of this variable (time evolution). ODE: Ordinary Differential Equation |
| CSemiDiscreteScheme | Under construction .. |
| CSrcNumericalTreatment | Basic algorithm to evaluate source terms (bed slope and energy slope) The Manning formula can be read as follow: |
| CSrcTreatmentS2 | Implementation using a different formula for Manning coefficient |
| CSweLDeltaOperator | To be completed ... see Swe_LDeltaOperator as base implementation U1n12 = w_LdeltaOp->applyTo(arr U1. arr U2).massEq(); // n+1/2 time step U1n12 = w_LdeltaOp->applyTo(arr U1. arr U2).momentumEq(); // ditto |
| CSweRhsAlgorithm | Abstract class. "Model" of the right-hand-side terms discretization. Hold discretization scheme or algorithm to be applied on each of them |
| CSweRhsData | Aggregate (must support operator[]) |
| CSweRhsDataP | Inherited aggregate (extended), add pressure term data |
| CUh | Container of nodal variables |
| CVS19WaveSimulator | DamBreak simulator base class (Wave Simulator) |
| NSfx | |
| CDamBreakData | Hold data for validation. Two type: EMcneil, Hudson (DamBreak config) |
| CDamBreakExSol | |
| CDamBreakInitialCnd | Sole responsibility is to provide wave profile at initial start up based on DamBreakData |
| CDbgLogger | Helper utility that save result to a file to be used for debugging and visualizing |
| CEMcNeilBndCnd | Calculate the characteristic information to set boundary node values (A,Q,H) |
| CExplicitOperator | Some prototype |
| CFiniteDifferenceDerivative | First derivative at second and fourth order. provide a stencil concept to evaluate derivative without spurious oscillations (ENO: Essentially Non-Oscillatory |
| CLDeltaOperator | Responsible to evaluate the spatial terms according to spatial discretization. The HOperator provides type and method to compute numerically the different terms of the right-hand-side of the equation. It also provide numerical container used for fast floating-point operation |
| CLogger | Class to output a message log file. Singleton base class manage the creation/deletion of the logger. That the instance function returns a pointer to a static variable and thus is declared static. Only the class function Instance can call the constructor. Public access to the constructor is denied. The constructor, copy constructor and assignment operator are all private to ensure that the programmer using the singleton class can only create a single instance of the class using only the Instance() function. The life of the singleton instantiation is for the duration of the application |
| CPhysicalAlgorithm | Abstract class provide an interface with services to implement physical based algorithm to solve st-Venant equations in a conservative form (divergence). Numerical integrate the numerical model in time ... advance ... to be completed |
| CPhysicalConfigure | Responsible to set initial configuration of the physical system (e.g. initial condition) |
| CPhysicalMeasurement | Physical measuremt taken on physical system (e.g. energy, friction, ...) |
| CSectionGeometryHandler | |
| CSimulation | Bean that represents a simulation in the framework. Many of the attributes of the simulation bean are defined in the Simulation.properties file by the user of the framework. The Controller class uses the simulation bean to control the creation of the correct classes for the simulation |
| CSimulationMgr | Global instance of the simulation. Hold the different parameters of run (simulation parameters). Use the CRTP (Curious Recursive Template Pattern) known as static polymorphism) |
| CStVenant1D | Shallow-water (one-dimension) is a system of conservation laws. Conserved quantities (state variables) are the mass and the momentum. It's the differential form of Newton law (f=ma) but for a mass of fluid in a movement under gravity. Forces that act on the mass of fluid are friction, gravity and pressure |
| CStVenant1DTerms | One-dimensional St-Venant equation spatial terms |
| NTestvs19 | |
| CBaseRhsPhysicsAlgorithm | Base RHS terms algoritm (support legacy code) |
| CBaseTypesPhysicsAlgorithm | First implementation from the re-factoring VS15 to VS19 (C++20) |
| CDamBreakMeasureAQH | Physical measure taken in the Physical system We are still experimenting we our new API that is under construction |
| CDamBreakSetup | Set up initial condition for DamBreak problem |
| CDamBreakSysConfigure | Class that profide a method to configure physical system. The configuration of a physical system is done before any operations or measurements are performed on the physical system. The class that will be used by the simulation should be defined in the Simulation.properties file in the following manner: PhysicalConfigurationClass=InitialSetup |
| CDamBreakSysMeasurement | This interface defines the required method for the Measurement bean. The user will define the necessary get and set methods for the bean on the quantities that are being measured as in the following example: ... public void setTotalEnergy(double E) { this.E = E; } |
| CDamBreakSystem | Physical system under study (physical object) |
| CDataStoreFactory | Data Store factory method |
| CEmcilAlgorithm | Algorithm that take care of the physics that we want to simulate. For example, Nujic in his article treat numerically pressure, source and flux depending on the physics |
| CEMcNeilAlgorithm | Concept of physical algoritm using components (set numerical method). This allow to program complex algorithms quickly by components. In project require to prototype according to physics assumptions. Each of these components are programmed or support a wide (large) implementation of discretization. For example, Nujic 1995 propose to use ENO techniques to compute flux and some source special treatment to take account ... Model of an explicit conservative scheme with source terms (energy and bed slope). Switch components to re-configure the algorithm (Nujic flux) but E. McNeil use HLL. This kind of flexibility must be supported particularly in industrial projects since ... to be completed |
| CFileDataStore | File based implementation of the DataStore interface. This class makes use of the toString() method defined in the PhysicalMeasurement interface |
| CFileFinalReport | Defines a simple way of reporting final statistics or calculations that occured in the simulation. To define the usage of a FinalReport implement the following in the Simulation.properties file in the following manner: FinalReportClass=Report DoFinalReport=true |
| CListSectionsFlow | List of physical objects under study |
| CListSectionsIterator | List iterator on list of sections flow |
| CNujic2StepsIntegrator | Numerical integration by two-steps Rungde-Kutta (second-order) |
| CNujicPhysicsAlgorithm | Nujic (1995) physics algorithm with assumptions ... . source treatment (slope bottom term) based on physics ... to be completed see prototype VS2015 for an imp |
| CNujicSrcTermAlgorithm | "Model of" function object (called functor). Calculate the "S0" .... slope term |
| CNumethod_f | This is a prototype!! just experimenting some implementation |
| CProtoPhysicalAlgorithm | Concept of physical algoritm using components (set numerical method). This allow to program complex algorithms quickly by components. In project require to prototype according to physics assumptions. Each of these components are programmed or support a wide (large) implementation of discretization. For example, Nujic 1995 propose to use ENO techniques to compute flux and some source special treatment to take account ... Model of an explicit conservative scheme with source terms (energy and bed slope). Switch components to re-configure the algorithm (Nujic flux) but E. McNeil use HLL. This kind of flexibility must be supported particularly in industrial projects since ... to be completed |
| CRetRhsType | Wrapper data type used as RHS (right-hand-side) return structure |
| CRhsType | |
| CSbSfTermsEvaluation | Wrapper of legacy code. Usage: SbSfTermsEvaluation w_S0Sf{listSections,bc1,bc2}; auto w_SfS0 = w_S0Sf.TraitementTermeS2(aField1,aField2); auto& w_rhs = m_rhsAlgo.getRHS(); w_rhs.m_swerhs.S = std::move(w_SfS0); |
| CValidateAlgo | Implement the physical algorithm that we use to validate our prototype within the Dam-Break simulation. Solve the ODE system by an explicit model. Spatial operator (right-hand-side) U_t = L_x of the St-Venant equations |
| CWave1DSimulator | Wave simulator (simulate dam-break wave propagation) implementation |
| CWaveSimulator | Wave simulator (simulate dam-break wave propagation) |
| CBaseNumericalTreatmemt | Base implementation according to Eric McNeil Eric McNeil original code use an approach based on Nujic but implement the numerical flux with a HLL algorithm. Re-use Nujic implementation of the source term and pressure terms, but provide also |
| CDamBreakSim | Base class for simulating the Dam Break Problem |
1.14.0