3D model shapes for AxiSEM-3D
Project description
AxiSEM3D_shapes
Author: Will Eaton, Princeton University 2021
Last modified: April 12th 2022
Contact: weaton@princeton.edu
Short description:
A small repo containing scripts to inject shapes such as ellipsoids, slabs and cylinders into 3D cartesian models for use in AxiSEM3D.
Overview:
Full documentation can be found ... . If you have any questions please open an issue or contact me via email.
Three classes provide the functionality of this package:
Model
is used to create a background cartesian grid into which shapes can be added. This can represent the entire domain you are simulating, or a subset of it. It holds, among other things, three arraysVP
,VS
andRHO
which eventually stored in NetCDF files for AxiSEM-3D to read.Shape
is an abstract base class. Subclasses of this (e.g.Ellipsoid
orCylinder
) can be instantiated and injected into the model arrays (e.g.VP
) using anInjector
objectInjector
are instantiated by passing in aModel
object, and are used to injectShape
objects into theModel
arrays.
Shapes can be created with dimensions and orientation specified by the user. Originally these codes were just written for injecting spheres. As such, the position of shapes is located by a central point of the shape, rather than an edge. I may add more flexibility for this in the future.
I recommend viewing your generated models in Paraview to check everything has worked, before running simulations.
Still to do:
- Complete testing of all scripts
- Global (spherical) wrapper for use in non-cartesian Axisem-3D.
- Parallel grid searches for shape construction?
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file axisem3Dshapes-1.0.3.tar.gz
.
File metadata
- Download URL: axisem3Dshapes-1.0.3.tar.gz
- Upload date:
- Size: 14.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 176154397d5528a911888b753779f51a027c46b88b8578b6fb7b7cd506a4047d |
|
MD5 | 0bb417d89b6238f39b36a72eacd6aa3e |
|
BLAKE2b-256 | c90f10be8edd14a9137f4c3d6abe2692792c1916f510e51f071b6527dd341481 |
File details
Details for the file axisem3Dshapes-1.0.3-py3-none-any.whl
.
File metadata
- Download URL: axisem3Dshapes-1.0.3-py3-none-any.whl
- Upload date:
- Size: 17.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 954d4c202193717d5a369063711d78cdfc3bc962064e0a263d330e7882b55976 |
|
MD5 | 0fca3f52c889d25fa7697212cd248bff |
|
BLAKE2b-256 | 0e8f46874106827f45972b37bb0834ad5605135c29ac3d2236901a2b3eb6e2f6 |