Quanscient.allsolve Documentation

Getting started

Introduction to projects

The Quanscient.allsolve project overview page is where you can view and manage all the projects that you have access to.

  • Filter the list of projects: The project list can be filtered to show all the full script projects, or projects with any of the chosen physics.
  • Search for projects: You can also search for projects by name or description, making it easy to find specific projects that match certain keywords.
  • View project details: You can navigate to each project's details page by clicking on the name of the project, where you can see more information and perform specific actions such as running simulations or editing the project settings.

Filtering the list of projects allows you to find exactly what you're looking for, quickly. You can filter the list to show only projects that are of a specific type, such as "Full Script" projects.

Additionally, you can filter the list to only show projects that have been created with specific physics. This filter is an "or" filter, which means that it will match any projects that have any of the selected physics, it's easy for you to quickly find projects that are relevant to your interests or needs.

How to start a project with a geometry

To start a project with a geometry in Quanscient.allsolve:

  1. Choose the option to create a new project and select "continue with geometry" when prompted.
  2. In the project creation dialog, you can select from a variety of pre-defined shapes, such as a sphere or a cylinder.
  3. Alternatively, you can import your own geometry using a file format like STEP or STL.
  4. Once the shape or geometry is selected, Quanscient.allsolve will create a new project with that shape or geometry.

From there, you can add additional features such as materials and physics to run your simulation.

How to do a full script project

Creating a new project using scripting in Quanscient.allsolve can be achieved by the following steps:

  1. Create a new project and name it "Full Script"
  2. Select the option for a pure script project.
  3. In the project interface, you will have access to the main script editor where you can add multiple script files if desired.
  4. You can upload any necessary mesh files using the input files functionality.
  5. In the script editor, use the "quanscient" module to access all necessary functionality and use the built-in autocomplete for functions.
  6. When your script is ready, set the node count and run the simulation.
  7. You can monitor the progress of the simulation through the log function.

How to import STEP files

The process of importing a STEP file into the .allsolve software can be achieved by following these steps:

  1. Open the .allsolve software and navigate to the home page.
  2. Click the "New Project" button to initiate the creation of a new project.
  3. Provide a suitable name for your project. Click the "Create Project" button to continue.
  4. Click the "Upload a Geometry File" button on the next screen to open a file explorer window.
  5. Navigate to the location of the STEP file you wish to import and select it. Click the "Open" button to begin importing the file.
  6. The model 3D view opens after importing has finished. The volumes and surfaces of the model can be viewed in the entities list.

Introduction to the model view controls

The model view controls in Quanscient.allsolve provide various options for viewing and manipulating the model. These controls can be found in the top left corner of the model view.

  • Translucent mode: This tool can be used to enable the translucent mode. Clicking this button allows you to view everything inside other volumes in a translucent manner. The opaque mode can be restored by clicking the button again.
  • Hide volumes: This tool can be used to hide individual volumes in the model. Once enabled, the state of the volumes can be seen in the entity tree under the volumes list. The hidden volumes can also be toggled in that same list. To unhide all volumes, click the "clear hidden" button.
  • Hide surfaces: This tool works the same as the hide volumes tool, but for surfaces instead of volumes. The hidden surfaces can be viewed and toggled in the surface list. And the "clear hidden" button will go back to the initial state.
  • Show axis: This tool can be used to show the axis in the model view. The direction of the axis can also be viewed in the bottom left corner of the model view.
  • Rotate tool: This allows you to rotate the view of the model simply by dragging with your mouse or touchpad. Holding down the shift key while doing so will allow you to rotate the view along a specific axis, determined by the direction of your drag.

Introduction to regions

Regions in Quanscient.allsolve are sets of entity tags that allow you to reference and group certain parts of a geometry for various purposes such as assigning material properties or defining boundary conditions.

Each entity within the geometry, such as a volume, surface or point, has a unique integer identifier called a tag.

These tags can be used to identify and reference the entity within the software.

In the Quanscient.allsolve, you can view the tags of entities in the entities list.

When you create a new region, you select specific entity tags to group them under the same region.

These regions can then be used throughout the software to reference and define the specific geometries.

Handling model geometries

How to add shapes

In Quanscient.allsolve, you can add various shapes to your project by following these steps:

  1. After creating a project, select the option to add new geometries from the available list of shapes.
  2. You can add boxes, spheres and other shapes as required.
  3. Adjust the properties of the added shapes as necessary.
  4. Press the "Apply Geometries" button to finalize the changes and update the volumes and surfaces in the entity lists.

How to add an airbox around a geometry

In Quanscient.allsolve, an airbox can be added around a geometry by following these steps:

  1. Navigate to the 'Geometry' tab and select 'Add Geometry'.
  2. From the dropdown menu, select the desired shape, such as a box, cylinder, or sphere. In this example, we will be using a box and naming it 'airbox'.
  3. Adjust the size and position of the airbox so that it fits around the imported model.
  4. Press the 'Apply Geometries' button to apply the changes.
  5. Depending on the complexity of the original model, the application process may take a few seconds to complete.
  6. Once the airbox has been added to the model, the translucent mode can be toggled to preview the original geometry underneath the airbox.

How to adjust a geometry

Adjusting an imported model in Quanscient.allsolve can be achieved by the following process:

  1. Navigate to the 'Geometry' tab and select the imported model you wish to adjust.
  2. Apply a geo operation in the form of a translation to reposition the model as desired. In this case, the Z axis value for the translation will be determined by measuring the displacement between the coil and the central part of the model, which is approximately 0.02 units.
  3. Press the "Apply Geometries" button to finalize the changes and update the model with the specified modifications.

How to remove volumes from geometry

To remove volumes from the imported geometry in Quanscient.allsolve:

  1. Navigate to the geo operations menu and select the "remove" option.
  2. Select the specific volumes that you want to remove from the imported geometry.
  3. Click on the "apply" button.

Note that this operation is irreversible, so be sure to double-check that you have selected the correct volumes before removing them. After completing these steps, the selected volumes will be removed from the imported geometry.

Scripting

How to use the script editor

The script editor workspace comprises several components, including input files and auto-generated scripts.

Input files such as custom mesh files and CSV files can be utilized within your script.

Auto-generated scripts make the regions, materials and shared expressions defined in the GUI easily available in your custom scripts.

The simulation.py file acts as the primary entry point for the simulation and initially contains the generated (if any defined in the GUI) physics. It is also possible to split your simulation into multiple modules by adding new files in “your scripts” -section.

To make modifications to an existing script, click on the script's name and edit as necessary. You can rename a script by double-clicking its name.

Several useful features are available in the script editor to aid the coding process, including syntax error checking, which alerts you to any errors in the code. Code autocomplete tool is also provided for easy access to the API and its reference documentation..

Introduction to script autocompletes

The script autocomplete function in Quanscient.allsolve supports:

  • In the code editor, you can use the intelligent autocompletes by hovering over function names to see their documentation.
  • Use the control space key to quickly fill in function names, properties, and parameters by accessing the autocomplete model.
  • Utilize the Python snippets provided, such as try/except for error handling and a transient snippet for simulating over time.

How to use more advanced scripting features

The script editor contains a feature of auto-generated folding blocks for any indentation in Python code.

By double-clicking on a word, it can be highlighted across the entire script.

The script editor also includes a search function which can be accessed by pressing the control or command F keys. This function allows for searching a specific word within the script and navigating through the search results using the arrow keys or the 'All' button.

The script editor includes a multi-cursor mode which can be enabled by pressing the alt or option key and dragging.

In addition to these features, the script editor includes a replace function within the search function, allowing to replace a single occurrence or all occurrences of a specific string by clicking the plus button.

The control Z key can be used to undo the change or use the shift key to redo it if a mistake is made.

Example simulation cases

How to set up a thermal conduction simulation

How to set up thermal conduction simulation in Quanscient.allsolve:

  1. Begin by creating a new project and naming it, for example, "Cylinder."
  2. In the project interface, add a cylinder shape to the project.
  3. Next, assign physical regions and material properties to the cylinder.
  4. In the "Physics" tab, add the "heat transfer" physics and select "steady state" as the type of analysis.
  5. Define the target for which this physics will be applied, for example, the cylinder.
  6. In the "Interactions" tab, add boundary conditions. For example, set a temperature of 1000 K for the top surface and 300 K for the bottom surface. A zero gradient boundary condition is automatically applied to the side surface.
  7. In the "Simulation" tab, run the simulation.
  8. Finally, go to the "Postprocessing" tab to view the results of the simulation.