Eddy3D Component list

Load example Grasshopper definitions for common workflows. Templates include microclimate simulations, outdoor comfort studies, and CFD analysis setups. Version: 1.8.0.827

Export geometry to STL format for OpenFOAM or other CFD tools. Supports meshes and Breps (auto-meshed); binary or ASCII, single or multiple files.

A boolean toggle that is always FALSE when a file is opened. Useful for preventing automatic execution of heavy ML models. Double-click to toggle.

Hold the last output while the left mouse button is pressed, then publish the newest value when the button is released. Useful between an MD Slider and an expensive component.

Define atmospheric boundary layer inflow conditions for Eddy3D.

Define inflow boundary conditions from a manually entered vertical profile (z/zR, U/UR, k/UR^2) instead of the parametric ABL log-law. Writes fixedProfile inlet conditions for U, k and epsilon. epsilon is derived from the profile as epsilon(z) = Cmu^0.5 * k(z) * d(U)/dz.

Create a uniform (constant velocity) inflow boundary condition for Eddy3D.

Download an EPW weather file from a direct URL, or search climate.onebuilding.org by station name, WMO ID, or dataset year.

Visualize a wind direction on a compass circle. Direction is meteorological degrees (0=N, 90=E, 180=S, 270=W); outputs the flow vector and the 16-point cardinal name.

Cluster annual wind directions into representative directions using k-means.

Assign a multi-face ground plate to the wind tunnel: each face gets its own aerodynamic roughness length z0 and becomes its own ground patch (nutkAtmRoughWallFunction). Feed into the wind case component's Ground Roughness input.

Fetch land-cover polygons around a location from OpenStreetMap (open data, Overpass API) and classify each into an aerodynamic roughness length via the Davenport-Wieringa terrain classification. Outputs ready-made ground roughness zones for the wind case.

Represents a tree as a porous zone for wind blocking (Darcy-Forchheimer). Feed into the wind case component.

Combine a multi-part building mesh into a single watertight, CFD-ready solid via the bundled Python mesh service (trimesh/manifold3d/pymeshfix). The server auto-starts locally on the first run (uv-managed Python environment; first start installs it, 1-2 minutes) and is reused afterwards.

Define a cylindrical simulation domain for Eddy3D. One cylindrical mesh serves all wind directions; the cylinder side faces switch between inlet and outlet per direction. The auto radius targets the 3% frontal-blockage limit of ASCE/SEI CWE Prestandard AC 6-8b, which the case component verifies. Model surrounding buildings within ~240 m of the study area (ASCE 49 proximity guidance) before trusting results near the context edge.

Compute the snappyHexMesh refinement level needed to reach a target cell size (each level halves the cell size).

Configure mesh refinement, layers, and grading for Eddy3D.

Add a custom snappyHexMesh refinement region (a box, solid or surface) to a written case's mesh. Refines the cells inside/near the geometry to the chosen level; re-run meshing separately afterward to apply it.

Generate centered surface samples on the actual faces of Brep, surface, or mesh geometry.

Reference an existing wind case folder (mesh/ + case_NNN) for post-processing.

Create, write, and manage an Eddy3D outdoor wind simulation case.

Writes meshing and simulation scripts (.bat / .sh) into a Scripts/ folder under the wind study, so the workflow can be launched manually outside Grasshopper. The scripts match what the Run component executes. Write the study to disk first (Wind Case 'Write').

Mesh and run an OpenFOAM case on the selected engine (wind / indoor / UMF).

Configure solver run controls for Eddy3D.

Inject a custom OpenFOAM function object into a written case so the solver runs it at runtime — fieldAverage, yPlus, wallShearStress, forces, surfaceFieldValue, a coded FO, etc.

Draws a wind case's residual convergence directly on the Grasshopper canvas, with lightweight timed updates. Wire the case and toggle 'Live' to monitor a running simulation without an external plotter window. When a warm-up ramp is enabled the solver restarts mid-run and writes a separate residual file per phase; all phases are stitched into one continuous curve so you see the full history (warm-up + main), not just the latest phase.

Monitor blockMesh, surfaceFeatures, and snappyHexMesh progress from the mesh case logs.

Open the web-based residual plotter for a wind case's convergence history (one trace per direction).

Translate a Ladybug analysis period to hours of the year.

Interactively select a month, day, and hour for annual analysis. Click the controls on the component to change the date and time.

Compute volumetric flow rates (m³/s) across a mesh, treating its vertices as velocity probes. Per face: average vertex velocities × face area × cos(angle to face normal).

Classifies pedestrian wind comfort per point from an annual hourly wind-speed series (the Wind Speed output of the Velocity Amplification Factors (VAF) component) against a comfort criterion (Lawson, Davenport, NEN8100). Returns the comfort category, class letter, and activity description for each point.

Compute Velocity Amplification Factors (VAF) and annual wind speed at probes from CFD results and EPW weather data. VAF (the term used in the wind-engineering literature for what Eddy3D historically called "wind factors") is the local wind speed normalized by the reference speed.

Visualize a probed wind field: colored velocity arrows, a point cloud, a heatmap mesh, streamlines, or volumetric smoke (pick via Display Mode). Feed the Probe component's points + velocity vectors (Field = U), or any points + vectors.

Color-scale legend for wind speed: a colored bar with labeled ticks matching the Wind Field Viewer's ramp. Wire the viewer's Range output into Range so the legend always shows the span the colors actually map, and pick the same Color Map.

Define an analysis period (from/to day of year, start/end hour of day) and output the hour-of-year indices it covers, for filtering annual results.

Convert a start date/time and optional end date/time into hour-of-year values (1–8760) for indexing annual hourly data.

Create an air region for the UMF case. OutdoorPlus

Build a solid building region for the UMF case: from the façade surface meshes, two material wall layers (outer + inner) are extruded inward to model heat and moisture transport through the building envelope.

Create a terrain region with materials and depth settings. OutdoorPlus

Create a vegetation region with properties and mesh settings. OutdoorPlus

Deconstruct a MetaFOAM Region instance.

Generate a multi-resolution terrain mesh from input geometry with a solid base. OutdoorPlus

Configure mesh refinement for building regions.

Creates a STL mesh from geometry using the gmsh application. Useful to create healthy mesh topologies for building elements.

Configure mesh settings for terrain and underground regions. OutdoorPlus

Configure mesh refinement for vegetation regions. OutdoorPlus

Select a building material from the list and override its properties.

Define soil material properties for terrain layers. OutdoorPlus

Select a terrain surface material from the list and override its properties. OutdoorPlus

Define vegetation property coefficients for canopy modeling. Shows the recommended coefficients (Leaf Length, rsMin, kc) by default; right-click to show all coefficients (Cd, C, nEvapSides). OutdoorPlus

Create, read, and manage an Outdoor+ (UMF microclimate) case. OutdoorPlus

Define simulation domain extents and refinement padding. OutdoorPlus

Convert specific humidity (w) and temperature (T) to relative humidity (%). OutdoorPlus

Configure snappyHexMesh settings for the simulation. OutdoorPlus

Configure simulation control settings for UMF. OutdoorPlus

Define simulation timing and optional weather-driven time series. OutdoorPlus

Read an EPW file and create a Weather object for the simulation. OutdoorPlus

Run the OpenFOAM checkMesh command for a case region. OutdoorPlus

Tests for buildings and trees for Eddy3D-OutdoorPlus simulation.

Parses log files in a case folder and reports any FOAM errors. OutdoorPlus

Configure the view-factor discretization for radiation modeling. OutdoorPlus

Deconstruct a Weather object into hourly time series values. OutdoorPlus

Build an isothermal indoor ventilation case (room + inlets + outlets + sinks) for OpenFOAM 12.

Build a CO2 species case (OpenFOAM 12 multicomponentFluid) with a breathing manikin.

Ventilation inlet — defines where air enters the room (diffuser, window, door). Direction is computed perpendicular to the surface, pointing into the room.

Ventilation outlet — defines where air exhausts from the room (return grille, open window).

A Darcy-Forchheimer momentum sink (filter/screen) box for an indoor ventilation case.

Set an indoor wall temperature (°C). Wire a room surface to give just that surface its own temperature patch; leave it empty for a single case-wide wall temperature.

A breathing occupant (LOD-0 body with a separate mouth patch) for the Indoor Species Case.

A CO2 passive-scalar source box for an indoor ventilation case.

A volumetric heat source box for an indoor ventilation case (transported temperature scalar).

A fan/jet momentum source (mean velocity) box for an indoor ventilation case.

An airborne-pathogen passive-scalar source box for an indoor ventilation case.

Grade indoor CO2 (ppm) against EN 16798-1 or another CO2-based IAQ standard.

External wind pressure on a facade per EN 1991-1-4, and the opening flow it drives.

CO2 generation rate of one occupant by age, activity and sex (Persily & de Jonge 2017).

Sleep-adapted Gagge two-node model (Yan et al. 2022) for bedrooms.

Gagge two-node thermal comfort: SET, ET, PMV, TSENS and DISC.

Air exchange through an open window (Maas 1995) and the steady-state CO2 it supports.

Prepare and launch a FluidX3D GPU wind simulation (builds the solver from source, runs on the GPU). LICENSE: FluidX3D (ProjectPhysX) is free for NON-COMMERCIAL use only — public research, education, or personal use. Commercial use is not permitted. See the FluidX3D LICENSE.

Solver controls for the FluidX3D GPU engine (memory, simulated time, export interval, and an interactive real-time window).

Prepare and launch a container-based OpenLB wind simulation (Smagorinsky LES, time-averaged pedestrian wind field). Uses the same ABL inflow object as the OpenFOAM and FluidX3D engines. Needs Docker Desktop or podman; the solver image is pulled on first run.

Solver controls for the container-based LBM wind engine (grid spacing, warmup and averaging windows, probe layer, GPU, container runtime).

Watch a FluidX3D wind solve live in the viewport: colors an analysis mesh with the velocity magnitude of the newest exported frame while the GPU solver runs, updating as each frame lands. Also shows the final field of a completed run. Wire either the Run component's Case or Folder output into Case, and supply the mesh to read the wind on (e.g. a pedestrian-level plane).

Read the time-averaged pedestrian wind field from an LBM case directory. Outputs world-frame points and velocity vectors — plug both into the Wind Field Viewer.

Create comfort sensor probes from meshes (one probe per face center, facing the face normal) and/or points (facing corresponding Normals), mixed freely on one input.

Solves MRT on a prepared VF Model: shortwave (direct raycast, or Radiance DDS when MRT Settings enables reflections) + view-factor longwave. Wire the VF Model straight from MRT View Factors for ambient/FFT surface temperatures, or through SurfaceTemp (EnergyPlus) for E+ temperatures. Result feeds Deconstruct MRT and UTCI.

Tags Breps or Meshes as a radiation surface for an MRT analysis. Breps are meshed at Patch Size; Meshes are used face-for-face as given.

Assembles tagged surfaces + sensors into a radiation model, builds the sky dome, and solves probe-to-polygon view factors. Feed the VF Model to SurfaceTemp (EnergyPlus) and/or MRT Solve. The sweep is the expensive part of an MRT run — solving it once here lets the downstream stages re-run without repeating it.

Thermal + optical material properties for a building/ground MRT surface.

Canopy material properties for an MRT tree surface.

Leaf/canopy material properties for an MRT vegetation surface.

Mean radiant temperature at each sensor, hour by hour. MRT = shortwave + longwave. SHORTWAVE — what the sensor absorbs from sun and sky. Either a direct raycast (default, pure C#) or the Radiance DDS chain (MRT Settings -> Radiance Reflections), which adds diffuse sky and interreflection off the surroundings. Radiance returns annual total and direct illuminance per sensor, which are mapped onto the probes' shortwave series. LONGWAVE — what the sensor exchanges with everything around it, weighted by view factors traced from each sensor against the scene and the sky dome. SURFACE TEMPERATURES come from ENERGYPLUS, not Radiance — Radiance is a light transport engine and computes no temperatures at all. With MRT Settings -> EnergyPlus Surfaces on, Eddy3D builds an epJSON from the polygons that actually matter to the sensors (those inside the cumulative view-factor percentile and above the small-face cutoff; everything else is demoted to a shading surface), runs EnergyPlus against the EPW, and maps the surface-specific temperatures out of the ESO back onto the geometry. With it off, every surrounding surface is simply assumed to sit at air temperature. SKY TEMPERATURE is always Clark-Allen from dew point, dry bulb, opaque cloud cover and relative humidity — it needs no engine.

Configuration for the MRT + UTCI analysis.

Direct sun hours and shadow by ray casting — an interactive preview, not a Radiance simulation.

Probe-specific statistics (and optionally the raw hours) from an MRT Result, without putting the full 8760-hour year on the canvas.

Colors the model's surfaces by view factor: the mean each face receives from all sensors, or one chosen sensor's view factors to every face. Values output is per face, in mesh face order, for custom gradients.

Equal-angle fisheye of the hemisphere above one sensor, as a colored mesh — a flat disk or a 3D dome (Display dropdown): sky, building, ground and vegetation per direction, plus the sensor's cosine-weighted sky view fraction.

Computes the Sky View Factor (SVF) for each input point using the Tregenza 145-patch sky subdivision. Casts 145 rays toward the upper hemisphere and returns the fraction of unobstructed sky directions (0 = fully obstructed, 1 = fully open sky).

Surface temperatures via EnergyPlus, mapped onto a solved VF Model. The counterpart of the FFT SurfaceTemp component for the staged MRT pipeline: it consumes MRT View Factors' output (the E+ surface selection depends on the view factors) and its output feeds MRT Solve. Skipping this stage leaves surfaces at ambient temperature unless they carry FFT temperatures from MRT Surface.

Predefined multi-layer construction (assembly) for the SurfaceTemp admittance solve.

Solves outdoor surface temperature per analysis point via the frequency-domain admittance method (no thermal mesh, no warm-up). Feeds a future MRT component alongside Sky Exposure. Method: Beckett, O., Owens, S. and Acred, A. (2026). Applying Frequency Domain Methods for Calculating Outdoor Surface Temperatures. Proceedings of the 12th National Conference of IBPSA-USA, Minneapolis, MN. https://publications.ibpsa.org/conference/paper/?id=simbuild2026_1312

Point-specific statistics (and optionally the raw hours) from a SurfaceTemp Result, without putting the full 8760-hour year on the canvas.

Compute a thermal comfort metric at a point: UTCI (Ta, RH, wind, MRT), PET (adds the personal inputs), or NOAA Heat Index (Ta, RH only). Pick the metric from the dropdown — the inputs adapt. Wire hourly lists (e.g. EPW series) to compute annual values.

Compute annual probe-specific UTCI from simulation outputs: MRT and wind-speed data trees, plus air temperature and relative humidity. For a weather-only calculator, use "UTCI (Weather)".

Bin an hourly point-specific series (e.g. UTCI) into a comfort range or the UTCI thermal-stress categories, per analysis period, and report hours/percent in each band. Feed it a point-specific DataTree (e.g. the UTCI component's output) and, optionally, one Analysis Period per branch (see the Analysis Period / Analysis Period To Hours components); an unwired period covers the whole series as one implicit Annual period.

Color UTCI, PET or NOAA Heat Index values by their thermal-stress categories and create a matching legend.

Compute and export wind dataset features from analysis points and building geometry.

Read processed CSV datasets back into Grasshopper. Supports mag_U and all spatial features.

Download an ONNX wind-prediction model from HuggingFace for the Wind Predictor component. Yel 2.0 is public; Esen 1.0 and Poyraz 1.0 need a HuggingFace token. All are 8-channel Wind Predictor models. (Yel 1.0 is a different architecture — the GAN image model used by GAN Predict via its API — and cannot be loaded here.) Models cache in ~/Eddy3D/Models/ and are reused on subsequent runs (a model already downloaded to the old ~/SUS_LAB/ folder is moved over, not re-fetched).

Export the solved MRT field as a machine-learning dataset: one row per sensor per hour with spatial features, hourly climate drivers and the MRT/UTCI targets.

Run ONNX wind-field prediction end-to-end. Computes SDF, building height, Zrelative, U/Uref, direction features from geometry, assembles the 8-channel input tensor, runs ONNX inference, and outputs predicted wind speeds. Supports legacy 1ch (U), 2ch (U + k) and new 4ch (U + k + Uroof + kroof) models.

Calculate Pedestrian Wind Comfort using predicted wind fields from the ONNX model.

Predict a pedestrian wind-speed field from buildings using the Eddy3D GAN (no CFD run). Sends the geometry to the GAN API and returns wind speeds + a colored result mesh.

Resample direction-specific wind-magnitude fields onto a new point grid (nearest-neighbour average, with direction-specific rotation). Prepares grids for GAN applications.

Write probed wind results as a CSV for the Eddy3D Visualizer (viz.eddy3d.com): columns X, Y, Z_relative, U_at_z, mag_U — one row per probe point. Upload the file at https://viz.eddy3d.com to view the 3D field, coloured by velocity magnitude.

Open a wind case's direction cases in ParaView. All directions are added to the ParaView pipeline browser; click Apply on the ones you want to load (nothing is loaded automatically).

Sample fields at points on a solved case, post-hoc. With Run it writes a probes function and runs postProcess on the requested Time (latest by default), then reads the results; without Run it reads existing results. Works on a wind case (one sub-result per direction) or a loaded case.

Inspect any Eddy3D case: Outdoor wind study, Indoor case, or OutdoorPlus (UMF) case.

Visualize faces that fail tet decomposition during topoSet. OutdoorPlus

Read cell connectivity and cell zones for a region. OutdoorPlus

Read and visualize sets produced by checkMesh. OutdoorPlus

Create a visualization mesh from polyMesh point/face data. OutdoorPlus

Export an OBJ mesh from a polyMesh description. OutdoorPlus

Remove ground mesh faces that intersect buildings, creating an analysis ground mesh with building footprints cut out.

Extract solver-side streamlines from a solved case with OpenFOAM's streamlines function object (particles tracked through the actual mesh — accurate in refined near-building cells, unlike tracing a probed field). With Run it writes the function-object dict and runs postProcess on the requested Time, then reads the tracks; without Run it reads existing tracks.