luminarycloud.params.simulation.physics

Submodules

• luminarycloud.params.simulation.physics.fluid
• luminarycloud.params.simulation.physics.heat
• luminarycloud.params.simulation.physics.solution_controls

Classes

Fluid	Configuration for a fluid flow physics solver - simulates the flow of liquids and gases.
Heat	Configuration for a heat transfer physics solver - simulates heat transfer in solid media.
PeriodicPair	Defines the input options needed for periodic boundaries. We assume each periodic BC can have translational OR rotational periodicity. To transform a point on boundary A to its periodically matching point on boundary B, we first subtract the center of rotation from the point coordinates to get the distance vector from the center to the point of interest, then we apply rotation around the periodicity axis and add back the center of rotation to get the coordinates of the transformed point.

Package Contents

class Fluid

Configuration for a fluid flow physics solver - simulates the flow of liquids and gases.

adjoint_controls: AdjointControlsFluid

basic: BasicFluid

Basic settings for a fluid flow physics solver.

boundary_conditions: list[BoundaryConditionsFluid] = []

Boundary conditions for a fluid flow physics solver. Possible types: Wall, Inlet, Outlet, Symmetry, Farfield from the boundary_conditions module.

initialization: InitializationFluid

Type of initial condition for the field variables. Possible types: FluidPrescribedValues, FluidFarfieldValues, FluidExistingSolution from the initialization module.

periodic_pair: list[PeriodicPair] = []

Defines the input options needed for periodic boundaries. We assume each periodic BC can have translational OR rotational periodicity. To transform a point on boundary A to its periodically matching point on boundary B, we first subtract the center of rotation from the point coordinates to get the distance vector from the center to the point of interest, then we apply rotation around the periodicity axis and add back the center of rotation to get the coordinates of the transformed point.

physical_behavior: list[PhysicalBehavior] = []

Physical behavior settings for a fluid flow physics solver.

porous_behavior: list[PorousBehavior] = []

Porous model settings for a fluid flow physics solver.

sliding_interfaces: list[SlidingInterfaces] = []

Defines the two sides that form a sliding interface. The two sides are abutting, possibly in combination with a periodic transformation, and should have the same normal grid velocity. The tangential grid velocity can, and usually will, be different. Each side of the sliding interface can be composed out of an arbitrary number of surfaces.

solution_controls: SolutionControlsFluid

Solution controls for a fluid flow physics solver.

spatial_discretization: SpatialDiscretizationFluid

Spatial discretization settings for a fluid flow physics solver.

turbulence: Turbulence

Turbulence settings for a fluid flow physics solver. Possible types: SpalartAllmaras, KomegaSst from the turbulence module.

class Heat

Configuration for a heat transfer physics solver - simulates heat transfer in solid media.

adjoint_controls: AdjointControlsHeat

boundary_conditions: list[BoundaryConditionsHeat] = []

Boundary conditions for a heat transfer physics solver. Possible types: HeatBcTemperature, HeatBcHeatFlux, HeatBcIntegratedHeatFlux, HeatBcSymmetry, HeatBcConvection from the boundary_conditions module.

heat_source: list[HeatSource] = []

initialization: InitializationHeat

Type of initial condition for the field variables. Possible types: HeatPrescribedValues, HeatExistingSolution from the initialization module.

periodic_pair: list[PeriodicPair] = []

Defines the input options needed for periodic boundaries. We assume each periodic BC can have translational OR rotational periodicity. To transform a point on boundary A to its periodically matching point on boundary B, we first subtract the center of rotation from the point coordinates to get the distance vector from the center to the point of interest, then we apply rotation around the periodicity axis and add back the center of rotation to get the coordinates of the transformed point.

sliding_interfaces: list[SlidingInterfaces] = []

Defines the two sides that form a sliding interface. The two sides are abutting, possibly in combination with a periodic transformation, and should have the same normal grid velocity. The tangential grid velocity can, and usually will, be different. Each side of the sliding interface can be composed out of an arbitrary number of surfaces.

solution_controls: SolutionControlsHeat

Solution controls for a heat transfer physics solver.

spatial_discretization: SpatialDiscretizationHeat

Spatial discretization settings for a heat transfer physics solver.

class PeriodicPair

Defines the input options needed for periodic boundaries. We assume each periodic BC can have translational OR rotational periodicity. To transform a point on boundary A to its periodically matching point on boundary B, we first subtract the center of rotation from the point coordinates to get the distance vector from the center to the point of interest, then we apply rotation around the periodicity axis and add back the center of rotation to get the coordinates of the transformed point.

center: luminarycloud.types.Vector3

Origin for the rotational periodicity transformation.

name: str = ''

rotation_vector: luminarycloud.types.Vector3

Holds the rotation vector needed to transform each point on the first periodic boundary to its matching point on the second periodic boundary. The vector direction defines the periodicity axis and its magnitude defines the periodicity angle, in degrees, from A to B according to the right-hand rule.

surfaces_side_a: list[str] = []

surfaces_side_b: list[str] = []

translation: luminarycloud.types.Vector3

Holds the translation vector in the x,y,z directions from each point on the first periodic boundary to its matching point on the second periodic boundary.