PorousMedia¶

This page provides comprehensive information about the structure and components of the data model, including detailed descriptions of the types and their properties, information on enumerations, and an overview of the ontologies used and their associated prefixes. Below, you will find a graph that visually represents the overall structure of the data model.

Graph

flowchart TB
    metadata(Metadata)
    author(Author)
    freeflow(FreeFlow)
    flowparameters(FlowParameters)
    model(Model)
    porousmedia(PorousMedia)
    hardware(Hardware)
    device(Device)
    camera(Camera)
    laser(Laser)
    seeding(Seeding)
    seedingparameters(SeedingParameters)
    triggering(Triggering)
    measurement(Measurement)
    calibration(Calibration)
    processstep(ProcessStep)
    operation(Operation)
    parameter(Parameter)
    software(Software)
    recording(Recording)
    metadata(Metadata) --> author(Author)
    metadata(Metadata) --> model(Model)
    metadata(Metadata) --> hardware(Hardware)
    metadata(Metadata) --> freeflow(FreeFlow)
    metadata(Metadata) --> measurement(Measurement)
    freeflow(FreeFlow) --> flowparameters(FlowParameters)
    model(Model) --> porousmedia(PorousMedia)
    hardware(Hardware) --> camera(Camera)
    hardware(Hardware) --> laser(Laser)
    hardware(Hardware) --> seeding(Seeding)
    hardware(Hardware) --> device(Device)
    hardware(Hardware) --> triggering(Triggering)
    seeding(Seeding) --> seedingparameters(SeedingParameters)
    measurement(Measurement) --> calibration(Calibration)
    measurement(Measurement) --> recording(Recording)
    measurement(Measurement) --> processstep(ProcessStep)
    processstep(ProcessStep) --> operation(Operation)
    processstep(ProcessStep) --> recording(Recording)
    processstep(ProcessStep) --> software(Software)
    operation(Operation) --> parameter(Parameter)

    click metadata "#metadata" "Go to Metadata"
    click author "#author" "Go to Author"
    click freeflow "#freeflow" "Go to FreeFlow"
    click flowparameters "#flowparameters" "Go to FlowParameters"
    click model "#model" "Go to Model"
    click porousmedia "#porousmedia" "Go to PorousMedia"
    click hardware "#hardware" "Go to Hardware"
    click device "#device" "Go to Device"
    click camera "#camera" "Go to Camera"
    click laser "#laser" "Go to Laser"
    click seeding "#seeding" "Go to Seeding"
    click seedingparameters "#seedingparameters" "Go to SeedingParameters"
    click triggering "#triggering" "Go to Triggering"
    click measurement "#measurement" "Go to Measurement"
    click calibration "#calibration" "Go to Calibration"
    click processstep "#processstep" "Go to ProcessStep"
    click operation "#operation" "Go to Operation"
    click parameter "#parameter" "Go to Parameter"
    click software "#software" "Go to Software"
    click recording "#recording" "Go to Recording"

Types¶

Metadata¶

The Metadata summarizes key information about the following dataset. It includes a description of the dataset's content, a descriptive name or ID of the dataset, and the date of creation. It also lists the contributors, highlights the research areas which are covered and specifies the specific porous media model investigated. Descriptive keywords help categorize the dataset and the the hardware used in the experiment is also stored. Free flow conditions of the turbulent air flow are also stored. The Metadata provides detailed information about the measurements conducted in the experiment.

description* string

Summary of the content and background of the dataset described in 3-5 sentences.

dataset_id* string

Descriptive name of the dataset or ID of the dataset.

date* string

Date & time when the dataset was created.

authors* list[Author]

Persons who worked on the dataset.

subjects* list[string]

Research subjects covered by the dataset.

model Model

Define the actual model which was investigated with the dataset.

keywords* list[string]

Descriptive keywords to describe the dataset.

devices* list[Hardware]

Experimental devices used in the dataset.

free_flow FreeFlow

Free flow conditions during the experiment

measurements list[Measurement]

Contains all measurements & recordings which were conducted during the experiment

Author¶

The Author section provides information about the persons involved in working on or creating the dataset.These information helps providing the identity and contact details of the authors associated with the dataset.

name* string

Full name of the author or the experimenter.

affiliation* string

Organisation to which the author belongs.

email* string

E-Mail adress of the author.

phone integer

Phone number of the author.

FreeFlow¶

The Free Flow section contains information about the shape, dimensions, and working fluid of the free flow channel.It provides details such as the shape of the flow channel's cross-section, the hydraulic diameter, height, width and depth of the channel and a description of the flow parameters of the working fluid.

shape* string

Shape of the flow channel's cross section (e.g. rectangular, round, ...)

hydraulic_diameter* float

Value of the channel's hydraulic diameter (m)

fluid* FlowParameters

Description of the free flow parameters during the dataset.

height float

Value of the channel height, assuming a rectangular channel. (m)

width float

Value of the flow channel width, assuming a rectangular channel. (m)

depth float

Value of the flow channel depth, assuming a rectangular channel. (m)

diameter float

Value of the flow channel diameter, assuming a round channel. (m)

FlowParameters¶

The Flow Parameters encompasses crucial details about the flow parameters of the working fluid used in the present dataset. These parameters provide a comprehensive understanding of the fluid's properties and flow conditions within the experiment.

fluid* string

Name of the free flow fluid (e.g. dry air, water, ...)

temperature* float

Value of the fluid temperature at the inlet. (K)

pressure* float

Value of the fluid pressure at the outlet. (Pa)

density* float

Value of the fluid density (kg/m^3)

kinematic_viscosity* float

Value of the fluid kinematic viscosity (m^2/s)

dynamic_viscosity* float

Value of the dynamic fluid viscosity (mPas)

mass_flux* list[float]

Value of the fluid mass flux (kg/s)

reynolds_number* list[float]

Value(s) of investigated channel Reynolds number(s). ( - )

Model¶

The Model section contains information about the location of the object in the flow channel.It provides details regarding the type of the present porous media model, its location relative to the free flow and if applicable, detailed parameters related to the model which was used.

type* string

What kind of object is located inside the flow channel? (porous media model, cylinder, ...)

location* string

Where is the object located inside the flow channel? (in, adjascent to, ... the free flow)

porous_media PorousMedia

Description of porous media parameters

cad_model bytes

CAD drawing of the used model (e.g. stored as a '.stl'-File)

PorousMedia¶

The Porous Media contains information regarding the parameters associated with the utilized porous media model.They include the topology of the porous media model, the dimensions and other relevant material properties.

topology* string

Definition of the porous media model topology.

height* float

Value of the porous media model height. (m)

width* float

Value of the porous media model width. (m)

depth* float

Value of the porous media model depth. (m)

porosity* float

Value of the porous media model porosity. ( - )

permeability float

Value of the porous media model permeability. (m^2)

periodicity_x float

Value of the porous media model periodicity in x-direction. (m)

periodicity_y float

Value of the porous media model periodicity in y-direction. (m)

wall_thickness float

Value of the porous media model wall thickness. (m)

Hardware¶

The Hardware includes descriptions of the camera systems, laser systems, seeding devices and materials, optical devices, and triggering systems utilized during the experiment.

camera* list[Camera]

Description of the used camera system.

laser* list[Laser]

Description of the used laser system.

seeding* list[Seeding]

Description of the used seeding device and seeding material.

optics list[Device]

Description of the used optical devices (e.g. laserarms, lenses, beamsplitter, sheet optics, ...).

triggering list[Triggering]

Description of the used triggering devices.

Device¶

The Device provides general information about the manufacturer and model of the used devices such as cameras, lasers, optics, triggering and seeding systems.

manufacturer* string

Name of the device's manufacturer.

model string

Name of the device's model.

Camera¶

It specifies details about the camera lenses and sensors which were used during the experiment.

manufacturer* string

Name of the device's manufacturer.

model string

Name of the device's model.

lens string

Name of the camera lens which were used.

sensor string

Description of the camera sensor which were used.

Laser¶

The Laser provides information about the laser wavelength, either the laser is pulsed or continuous as well as the laser power.

manufacturer* string

Name of the device's manufacturer.

wavelength* float

Value of the used wavelength of the laser. (nm)

model string

Name of the device's model.

type string

Type of the used laser (e.g. pulsed or continuous wave laser, ...)

power float

Value of the laser power. (W)

Seeding¶

The Seeding describes the material of the seeding particles, the type of them as well as their density, particle size, and kinematic viscosity.

manufacturer* string

Name of the device's manufacturer.

particles* SeedingParameters

Seeding parameters of the used seeding material during the experiment.

model string

Name of the device's model.

SeedingParameters¶

The Seeding Parameters contains crucial information about the seeding material used in the experiment.It includes details such as the material name, particle type, density, particle size and the kinematic viscosity of the seeding particles.These parameters provide valuable insights integero the characteristics of the seeding material and its influence on the fluid flow behavior within the experimental setup.

material* string

Name of the seeding material.

phase* string

Phase of the seeding material which was used (e.g. solid, liquid, ...).

density* float

Value of the seeding particle density. (kg/m^3)

particle_size* float

Value or span of the seeding particle diameter. (m)

kinematic_viscosity float

Value of the seeding particle kinematic viscosity (m^2/s)

Triggering¶

The Triggering explains the recording mode employed during the experiment.

manufacturer* string

Name of the device's manufacturer.

recording_mode* string

Type of recording mode during the experiment (e.g. time-based, cyclic time-based, ...).

model string

Name of the device's model.

Measurement¶

The Measurement encompasses key details about the conducted experiment and its calibration.

name* string

Name of the experiment.It should contain all relevant information about the experiment.

calibration list[Calibration]

Calibration that has been done before the actual experiment.

recordings list[Recording]

Recordings that have been done in the course of the experiment.

processing_steps list[ProcessStep]

Processing steps and processed video data of the experiment

Calibration¶

The Calibration contains information about the parameters used during the recording process.The parameters are providing insights integero the camera position relative to the experiment for correcting possible misalignments.

calibration_type* string

Specify the calibration plate and/or the calibration facility which was used for calibration.

scale_factor* float

Value of the scale factor of the recordings.The amount of pixels corresponding to the length of 1 mm. (px/mm)

camera_position_translation float

Value of the translation of the camera position relative to the calibration plate. (m)

camera_position_rotation float

Value of the rotation of the camera position relative to the calibration plate. (°)

calibration_image bytes

The actual calibration image which was used.

ProcessStep¶

The Process Step outlines the specific processing steps applied to the flow measurement video data.It includes the name of each processing step, the resulting video from the processing, and the software used to post-process the data.Additionally, files with the extension ".lvs" from the Davis 10 software can be embedded within this section, providing a comprehensive record of the processing workflow and ensuring the availability of relevant files for reference and replication.

name* string

Full name of the processing step.

operation_list list[Operation]

List of processing steps carried out with the processing software.

processed_recording list[Recording]

Resulting video after applying the process steps and the raw video.

software* list[Software]

Software that has been used to perform the processing steps.

Operation¶

The Operation section defines the specific operations performed during the data processing.It includes the name of the operation, its description, and the parameters used in the operation.

name* string

Name of the operation.

description string

Description of the operation.

parameters list[Parameter]

Parameters of the operation.

Parameter¶

The Parameter section defines the specific parameters used in various operations during the data processing. It includes the name of the parameter and its corresponding value, which can be a float, string, or boolean. This information is crucial for understanding the exact configuration of each operation and ensuring reproducibility of the processing steps.

name* string

Name of the parameter.

value float``string``boolean

Value of the parameter.

Software¶

The Software section serves as a container for general information about the software utilized in the experiment.It includes details such as the name of the manufacturer, the specific software name, and the version used to generate the dataset.These details provide important context for the experiment, allowing for reproducibility and facilitating a clear understanding of the software environment in which the data analysis and processing were performed.

manufacturer* string

Name of the used recording or processing software manufacturer.

name* string

Name of the used recording or processing software.

version string

Version of the used recording or processing software.

Recording¶

The Recording contains crucial information about the parameters used during the recording process.These parameters offer valuable insights integero the experimental setup, facilitating accurate analysis and integererpretation of the recorded data. The inclusion of the video frames allows for a visual reference and further examination of the recorded footage.

time* float

Value of the investigated time period. (s)

repetition_rate* float

Value of the recording repetition rate. (Hz)

field_of_view* string

Value of the field of view. (m x m)

n_frames integer

Number of frames found in this video.

frames bytes

The actual Videoframes of the raw video

location string

Specify the local filepath to the location of the recordings.