proteus.mprans.SW2D module¶

class proteus.mprans.SW2D.SubgridError(coefficients, nd, lag=False, nStepsToDelay=0, hFactor=1.0)[source]¶

Bases: proteus.SubgridError.SGE_base

initializeElementQuadrature(mesh, t, cq)[source]¶

updateSubgridErrorHistory(initializationPhase=False)[source]¶

calculateSubgridError(q)[source]¶

class proteus.mprans.SW2D.NumericalFlux(vt, getPointwiseBoundaryConditions, getAdvectiveFluxBoundaryConditions, getDiffusiveFluxBoundaryConditions, getPeriodicBoundaryConditions=None, h_eps=1e-08, tol_u=1e-08)[source]¶

Bases: proteus.NumericalFlux.ShallowWater_2D

hasInterior = False[source]¶

class proteus.mprans.SW2D.ShockCapturing(coefficients, nd, shockCapturingFactor=0.25, lag=False, nStepsToDelay=3)[source]¶

Bases: proteus.ShockCapturing.ShockCapturing_base

initializeElementQuadrature(mesh, t, cq)[source]¶

updateShockCapturingHistory()[source]¶

class proteus.mprans.SW2D.Coefficients(nu=1.004e-06, g=9.8, nd=2, sd=True, movingDomain=False, useRBLES=0.0, useMetrics=0.0)[source]¶

Bases: proteus.TransportCoefficients.TC_base

The coefficients for the shallow water equations

attachModels(modelList)[source]¶

initializeMesh(mesh)[source]¶

initializeElementQuadrature(t, cq)[source]¶

initializeElementBoundaryQuadrature(t, cebq, cebq_global)[source]¶

initializeGlobalExteriorElementBoundaryQuadrature(t, cebqe)[source]¶

updateToMovingDomain(t, c)[source]¶

evaluate(t, c)[source]¶

class proteus.mprans.SW2D.LevelModel(uDict, phiDict, testSpaceDict, matType, dofBoundaryConditionsDict, dofBoundaryConditionsSetterDict, coefficients, elementQuadrature, elementBoundaryQuadrature, fluxBoundaryConditionsDict=None, advectiveFluxBoundaryConditionsSetterDict=None, diffusiveFluxBoundaryConditionsSetterDictDict=None, stressTraceBoundaryConditionsSetterDictDict=None, stabilization=None, shockCapturing=None, conservativeFluxDict=None, numericalFluxType=None, TimeIntegrationClass=None, massLumping=False, reactionLumping=False, options=None, name='SW2D', reuse_trial_and_test_quadrature=True, sd=True, movingDomain=False)[source]¶

Bases: proteus.Transport.OneLevelTransport

nCalls = 0[source]¶

getResidual(u, r)[source]¶

Calculate the element residuals and add in to the global residual

getJacobian(jacobian)[source]¶

calculateElementQuadrature()[source]¶

Calculate the physical location and weights of the quadrature rules and the shape information at the quadrature points.

This function should be called only when the mesh changes.

calculateElementBoundaryQuadrature()[source]¶

Calculate the physical location and weights of the quadrature rules and the shape information at the quadrature points on element boundaries.

This function should be called only when the mesh changes.

calculateExteriorElementBoundaryQuadrature()[source]¶

Calculate the physical location and weights of the quadrature rules and the shape information at the quadrature points on global element boundaries.

This function should be called only when the mesh changes.

estimate_mt()[source]¶

calculateSolutionAtQuadrature()[source]¶

calculateAuxiliaryQuantitiesAfterStep()[source]¶

getForce(cg, forceExtractionFaces, force, moment)[source]¶