diff --git a/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_API_V1_ArchV2/changelog.md b/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_API_V1_ArchV2/changelog.md index dd77a52ed0..0b68873e7f 100644 --- a/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_API_V1_ArchV2/changelog.md +++ b/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_API_V1_ArchV2/changelog.md @@ -1,3 +1,22 @@ # Changelog -## 2025 R2.1 \ No newline at end of file +This file lists the changes introduced in the AVxcelerate Explore API v0.1.0 released in 2025 R2. + +The AVxcelerate Explore API v0.1.0 is compatible with the AVX Architecture V2. + +The AVxcelerate Explore API v0.1.0 allows you to perform operations related to jobs and create post job sessions. + +## Features + +### Jobs: + The API allows you to perform the following operations related to jobs: +* Create a new job as per provided parameters +* Get a single or multiple jobs by their IDs +* Kill a running job +* Restart a completed or killed job +* Clone a job +### Post Job Sessions: +* This API allows you to create a post job session for a job and returns the relative URL to access the session. +* The session can then be used to perform various post-processing operations such as: viewing results, analyzing data etc. + + diff --git a/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_API_V1_ArchV2/intro_archv2_.md b/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_API_V1_ArchV2/intro_archv2_explore.md similarity index 70% rename from 2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_API_V1_ArchV2/intro_archv2_.md rename to 2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_API_V1_ArchV2/intro_archv2_explore.md index ec4fd873ea..d2f4add357 100644 --- a/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_API_V1_ArchV2/intro_archv2_.md +++ b/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_API_V1_ArchV2/intro_archv2_explore.md @@ -1,12 +1,26 @@ -# AVx Python APIs Documentation -## Background -The AVx python APIs are hosted as a python package on cluster as part of the Explore service deployment. The developers can install the package using pip and use it to call AVx autonomy APIs without the need to make raw REST calls. +## Features + +### Jobs: + The API allows you to perform the following operations related to jobs: +* Create a new job as per provided parameters +* Get a single or multiple jobs by their IDs +* Kill a running job +* Restart a completed or killed job +* Clone a job +### Post Job Sessions: +* This API allows you to create a post job session for a job and returns the relative URL to access the session. +* The session can then be used to perform various post-processing operations such as: viewing results, analyzing data etc. + + +## Introduction + +The AVx python APIs are hosted as a python package on a cluster as part of the Explore service deployment. The developers can install the package using pip and use it to call AVx autonomy APIs without the need to make raw REST calls. PyPi Regsitry URL: -The python package is hosted as PyPi compliant registry on each deployed cluster. The registry URL looks like this: +The python package is hosted as PyPi compliant registry on each deployed cluster. The registry URL is as written below: https://BASE_URL/pypi @@ -18,7 +32,8 @@ For example, for AFT deployment: Pre-requisites: -We are assuming that on the system is running **Ubuntu 22.04**, there are following already installed: + +We assume that on the system is running on the **Ubuntu 22.04** version, and that the following tools are already installed: - python 3.10 - pip 25.1 diff --git a/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/changelog.md b/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/changelog.md index dd77a52ed0..f93b6de050 100644 --- a/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/changelog.md +++ b/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/changelog.md @@ -1,3 +1,24 @@ # Changelog -## 2025 R2.1 \ No newline at end of file +This file lists the changes introduced in the AVxcelerate Resource Manager API v0.1.0 released in 2025 R2. + +The AVxcelerate Resource Manager API v0.1.0 is compatible with the AVX Architecture V2. + +This API allows to perform CRUD (Create, Read, Update, and Delete) operations on resources such as queues, deployments, applications and app-runtime-configurations. + +## Features + +### Queues: +* You can create queues with the required storages, resource limits and environment variables +* Allowing to manage queues helps will help you configure different applications within resource limits and group the applications requiring same storage together. +* You can adjust the maximum number of workers that can concurrently run on a queue using the parameter 'maximum_allowed_worker_instances' + +### Plugins: + You can register a plugin with definition of container runtime. +For example: Docker Engine / Kubernetes + +### Jobs: +* You can submit a resource-manager job by providing application details (name, version, image, environment variables, etc.) and track it to its completion. +* You can also check the status of the job and clean the resources the job has acquired. + + diff --git a/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/explore.aws-pre-prod-api-resources-v1.json b/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/explore.aws-pre-prod-api-resources-v1.json index 015643ccc5..0eb1184f29 100644 --- a/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/explore.aws-pre-prod-api-resources-v1.json +++ b/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/explore.aws-pre-prod-api-resources-v1.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Resource Manager API","summary":"Service to manage resources to run the jobs.","description":"\n## API allows to perform CRUD operations on resources such as queues, deployments, applications, app-runtime-configs.\n### Features\n- **Queues**:\n - User can create queues with the required storages, resource limits and environment variables\n - Allowing to manage queues helps user to configure different applications within resource limits and group the\n applications requiring same storages together.\n- **Plugins**:\n - User can register a plugin with definition of container runtime.\n - Example, Docker Engine / Kubernetes\n- **Jobs**:\n - User can submit a resource-manager job by providing application details (name, version, image, environment\n variables, etc.) & track it to its completion.\n - User can also check the status of the job and clean the resources job has acquired.\n","contact":{"name":"Ansys AVxcelerate Autonomy","url":"https://developer.ansys.com/docs/avxcelerate","email":"TeamTyson@ansys.com"},"version":"0.1.0"},"servers":[{"url":"/api/resources/v1"}],"paths":{"/health":{"get":{"tags":["health"],"summary":"Health","description":"Returns healthy message.","operationId":"health-health","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"type":"string"},"type":"object","title":"Response Health-Health"}}}}},"security":[{"HTTPBearer":[]}]}},"/queues":{"post":{"tags":["queues"],"summary":"Create Queue","description":"Create a new queue.\n\n:param queue: The queue to create","operationId":"queues-create_queue","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Queues-Create Queue"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"put":{"tags":["queues"],"summary":"Update Queue","description":"Update a queue using its name.\n\n:param queue: The queue to update","operationId":"queues-update_queue","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Queues-Update Queue"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"get":{"tags":["queues"],"summary":"Get Queues","description":"Get all queues using filter.\n\n:param filter_exp: OData filter to filter queues\n:param offset: items to skip\n:param limit: number of items to retrieve","operationId":"queues-get_queues","parameters":[{"name":"filter_exp","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter expression","description":"The expression must be compatible with OData"},"description":"The expression must be compatible with OData"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","title":"The pagination offset","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"title":"The pagination limit","default":100}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QueueRead"},"title":"Response Queues-Get Queues"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/queues/{queue_id}":{"get":{"tags":["queues"],"summary":"Get Queue","description":"Get a queue by its id.\n\n:param queue_id: id of the queue to retrieve","operationId":"queues-get_queue","parameters":[{"name":"queue_id","in":"path","required":true,"schema":{"type":"integer","title":"Queue Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/jobs":{"post":{"tags":["jobs"],"summary":"Create Job","description":"Create a new job.\n\n:param job: The job to create","operationId":"jobs-create_job","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Jobs-Create Job"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"get":{"tags":["jobs"],"summary":"Get Jobs","description":"Get all jobs using filter.\n\n:param filter: OData filter to filter jobs\n:param offset: items to skip\n:param limit: number of items to retrieve","operationId":"jobs-get_jobs","parameters":[{"name":"filter_exp","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter Exp"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobRead"},"title":"Response Jobs-Get Jobs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/jobs/{job_id}":{"get":{"tags":["jobs"],"summary":"Get Job","description":"Get a job by its id.\n\n:param job_id: id of the job to retrieve","operationId":"jobs-get_job","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"integer","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/jobs/{job_id}/status":{"get":{"tags":["jobs"],"summary":"Get Job Status","description":"Get job status by its id.\n\n:param job_id: id of the job to retrieve","operationId":"jobs-get_job_status","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"integer","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStatusEnum"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/jobs/{job_id}/clean":{"post":{"tags":["jobs"],"summary":"Clean Job","description":"Clean job resources.\n\n:param job_id: id of the job to clean","operationId":"jobs-clean_job","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"integer","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/plugins":{"get":{"tags":["plugins"],"summary":"Get Plugins","description":"Get all plugins.","operationId":"plugins-get_plugins","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PluginConfiguration"},"type":"array","title":"Response Plugins-Get Plugins"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["plugins"],"summary":"Register Plugin","description":"Register a new plugin.\n\n:param plugin: The plugin configuration","operationId":"plugins-register_plugin","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PluginConfiguration"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PluginConfiguration"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/applications":{"get":{"tags":["applications"],"summary":"Get Applications","description":"Get applications.","operationId":"applications-get_applications","parameters":[{"name":"filter_exp","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter expression","description":"The expression must be compatible with OData"},"description":"The expression must be compatible with OData"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","title":"The pagination offset","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"title":"The pagination limit","default":100}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationRead"},"title":"Response Applications-Get Applications"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["applications"],"summary":"Create Application","description":"Creates a new application.\n\n:param application: The application to create","operationId":"applications-create_application","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Applications-Create Application"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"put":{"tags":["applications"],"summary":"Update Application","description":"Updates an application.\n\n:param application: The application to update","operationId":"applications-update_application","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Applications-Update Application"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/applications/{app_id}":{"get":{"tags":["applications"],"summary":"Get Application","description":"Gets application by its id.\n\n:param app_id: id of the application","operationId":"applications-get_application","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"integer","title":"App Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/app-runtime-config/application/{app_id}":{"get":{"tags":["app-runtime-config"],"summary":"Get App Runtime Configs For Application","description":"Get all queues registered for given application id.\n\nIt retrieves the queues for the provided application from AppRuntimeConfig Model.\n\n:param app_id: Optional field if provided returns the registered queues for given application\n:param filter_exp: OData filter to filter queues\n:param offset: items to skip\n:param limit: number of items to retrieve","operationId":"app-runtime-config-get_app_runtime_configs_for_application","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"integer","title":"App Id"}},{"name":"filter_exp","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter expression","description":"The expression must be compatible with OData"},"description":"The expression must be compatible with OData"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","title":"The pagination offset","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"title":"The pagination limit","default":100}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRuntimeConfigRead"},"title":"Response App-Runtime-Config-Get App Runtime Configs For Application"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/app-runtime-config":{"get":{"tags":["app-runtime-config"],"summary":"Get App Runtime Config","description":"Get application queue for given queue id and application id.\n\n:param queue_id: queue id\n:param app_id: application id","operationId":"app-runtime-config-get_app_runtime_config","parameters":[{"name":"queue_id","in":"query","required":true,"schema":{"type":"integer","title":"Queue Id"}},{"name":"app_id","in":"query","required":true,"schema":{"type":"integer","title":"App Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRuntimeConfigRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/app-runtime-config/{queue_id}/application/{app_id}":{"post":{"tags":["app-runtime-config"],"summary":"Register Application To Queue","description":"Registers an application to the provided queue.\n\n:param queue_id: The queue where the application will be registered\n:param app_id: The application to register","operationId":"app-runtime-config-register_application_to_queue","parameters":[{"name":"queue_id","in":"path","required":true,"schema":{"type":"integer","title":"Queue Id"}},{"name":"app_id","in":"path","required":true,"schema":{"type":"integer","title":"App Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRuntimeConfigCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response App-Runtime-Config-Register Application To Queue"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"put":{"tags":["app-runtime-config"],"summary":"Update Application To Queue","description":"Update an application to the provided queue.\n\n:param queue_id: The queue where the application will be registered\n:param app_id: The application to update","operationId":"app-runtime-config-update_application_to_queue","parameters":[{"name":"queue_id","in":"path","required":true,"schema":{"type":"integer","title":"Queue Id"}},{"name":"app_id","in":"path","required":true,"schema":{"type":"integer","title":"App Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRuntimeConfigCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response App-Runtime-Config-Update Application To Queue"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}}},"components":{"schemas":{"AppRuntimeConfigAttributes":{"properties":{"image":{"type":"string","title":"Image"},"working_dir":{"type":"string","title":"Working Dir"},"mount":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Mount"},"network":{"type":"string","title":"Network"},"ports":{"items":{"type":"integer"},"type":"array","title":"Ports"}},"type":"object","title":"AppRuntimeConfigAttributes","description":"Attribute definition for AppRuntimeConfig data model."},"AppRuntimeConfigCreate":{"properties":{"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"default_resources":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"attributes":{"anyOf":[{"$ref":"#/components/schemas/AppRuntimeConfigAttributes"},{"type":"null"}]},"service_port":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Service Port"}},"type":"object","title":"AppRuntimeConfigCreate","description":"AppRuntimeConfig definition for creation."},"AppRuntimeConfigRead":{"properties":{"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"default_resources":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"attributes":{"anyOf":[{"$ref":"#/components/schemas/AppRuntimeConfigAttributes"},{"type":"null"}]},"service_port":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Service Port"},"app_id":{"type":"integer","title":"App Id"},"queue_id":{"type":"integer","title":"Queue Id"},"application":{"$ref":"#/components/schemas/ApplicationRead"},"queue":{"$ref":"#/components/schemas/QueueRead"}},"type":"object","required":["app_id","queue_id","application","queue"],"title":"AppRuntimeConfigRead","description":"Public application queue definition."},"ApplicationAttributes":{"properties":{"kpis":{"items":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object"},"type":"array","title":"Kpis"},"assets":{"items":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object"},"type":"array","title":"Assets"},"solver_settings":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Solver Settings"}},"type":"object","title":"ApplicationAttributes","description":"Attribute definition for Application data model."},"ApplicationCreate":{"properties":{"name":{"type":"string","title":"Name"},"version":{"type":"string","title":"Version"},"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"parent":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent"},"application_type":{"type":"string","title":"Application Type"},"attributes":{"anyOf":[{"$ref":"#/components/schemas/ApplicationAttributes"},{"type":"null"}]}},"type":"object","required":["name","version"],"title":"ApplicationCreate","description":"Application definition for creation."},"ApplicationRead":{"properties":{"name":{"type":"string","title":"Name"},"version":{"type":"string","title":"Version"},"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"parent":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent"},"application_type":{"type":"string","title":"Application Type"},"attributes":{"anyOf":[{"$ref":"#/components/schemas/ApplicationAttributes"},{"type":"null"}]},"id":{"type":"integer","title":"Id"}},"type":"object","required":["name","version","id"],"title":"ApplicationRead","description":"Public application definition."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"JobCreate":{"properties":{"name":{"type":"string","title":"Name"},"queue_id":{"type":"integer","title":"Queue Id"},"parent_job_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent Job Id"},"application_id":{"type":"integer","title":"Application Id"},"arguments":{"items":{"type":"string"},"type":"array","title":"Arguments","default":[]},"replica_count":{"type":"integer","title":"Replica Count","default":1},"auto_clean":{"type":"boolean","title":"Auto Clean","default":false},"resources_requested":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"labels":{"additionalProperties":{"type":"string"},"type":"object","title":"Labels","default":{}},"attributes":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Attributes","default":{}}},"type":"object","required":["name","queue_id","application_id"],"title":"JobCreate","description":"Job definition on creation."},"JobRead":{"properties":{"name":{"type":"string","title":"Name"},"queue_id":{"type":"integer","title":"Queue Id"},"parent_job_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent Job Id"},"application_id":{"type":"integer","title":"Application Id"},"arguments":{"items":{"type":"string"},"type":"array","title":"Arguments","default":[]},"replica_count":{"type":"integer","title":"Replica Count","default":1},"auto_clean":{"type":"boolean","title":"Auto Clean","default":false},"resources_requested":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"labels":{"additionalProperties":{"type":"string"},"type":"object","title":"Labels","default":{}},"attributes":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Attributes","default":{}},"id":{"type":"integer","title":"Id"},"internal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Id"},"status":{"$ref":"#/components/schemas/JobStatusEnum"},"cleaned":{"type":"boolean","title":"Cleaned"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"status_updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Status Updated At"},"failed_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failed Reason"}},"type":"object","required":["name","queue_id","application_id","id","internal_id","status","cleaned","created_at","status_updated_at","failed_reason"],"title":"JobRead","description":"Public job definition."},"JobStatusEnum":{"type":"string","enum":["pending","running","failed","succeeded"],"title":"JobStatusEnum","description":"Enum of job status."},"JsonValue":{},"PluginConfiguration":{"properties":{"name":{"type":"string","title":"Name"},"module_name":{"type":"string","title":"Module Name"},"class_name":{"type":"string","title":"Class Name"},"attributes":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Attributes","default":{}}},"type":"object","required":["name","module_name","class_name"],"title":"PluginConfiguration","description":"Plugin configuration."},"QueueCreate":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"plugin":{"type":"string","title":"Plugin"},"working_dir":{"type":"string","title":"Working Dir","default":"/jobs"},"default_resources":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"maximum_resources":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"attributes":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Attributes","default":{}},"storages":{"items":{"$ref":"#/components/schemas/JsonValue"},"type":"array","title":"Storages","default":[]},"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}}},"type":"object","required":["name","description","plugin"],"title":"QueueCreate","description":"Queue definition for creation."},"QueueRead":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"plugin":{"type":"string","title":"Plugin"},"working_dir":{"type":"string","title":"Working Dir","default":"/jobs"},"default_resources":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"maximum_resources":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"attributes":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Attributes","default":{}},"storages":{"items":{"$ref":"#/components/schemas/JsonValue"},"type":"array","title":"Storages","default":[]},"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"id":{"type":"integer","title":"Id"}},"type":"object","required":["name","description","plugin","id"],"title":"QueueRead","description":"Public queue definition."},"ResourcesDefinition":{"properties":{"cpu":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cpu"},"memory_gb":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Memory Gb"}},"type":"object","title":"ResourcesDefinition","description":"Resource definition."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"AVxcelerate Resource Manager API","summary":"Service to manage resources to run the jobs.","description":"\n## API allows to perform CRUD operations on resources such as queues, deployments, applications, app-runtime-configs.\n### Features\n- **Queues**:\n - User can create queues with the required storages, resource limits and environment variables\n - Allowing to manage queues helps user to configure different applications within resource limits and group the\n applications requiring same storages together.\n- **Plugins**:\n - User can register a plugin with definition of container runtime.\n - Example, Docker Engine / Kubernetes\n- **Jobs**:\n - User can submit a resource-manager job by providing application details (name, version, image, environment\n variables, etc.) & track it to its completion.\n - User can also check the status of the job and clean the resources job has acquired.\n","contact":{"name":"Ansys AVxcelerate Autonomy","url":"https://developer.ansys.com/docs/avxcelerate","email":"TeamTyson@ansys.com"},"version":"0.1.0"},"servers":[{"url":"/api/resources/v1"}],"paths":{"/health":{"get":{"tags":["health"],"summary":"Health","description":"Returns healthy message.","operationId":"health-health","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"type":"string"},"type":"object","title":"Response Health-Health"}}}}},"security":[{"HTTPBearer":[]}]}},"/queues":{"post":{"tags":["queues"],"summary":"Create Queue","description":"Create a new queue.\n\n:param queue: The queue to create","operationId":"queues-create_queue","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Queues-Create Queue"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"put":{"tags":["queues"],"summary":"Update Queue","description":"Update a queue using its name.\n\n:param queue: The queue to update","operationId":"queues-update_queue","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Queues-Update Queue"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"get":{"tags":["queues"],"summary":"Get Queues","description":"Get all queues using filter.\n\n:param filter_exp: OData filter to filter queues\n:param offset: items to skip\n:param limit: number of items to retrieve","operationId":"queues-get_queues","parameters":[{"name":"filter_exp","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter expression","description":"The expression must be compatible with OData"},"description":"The expression must be compatible with OData"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","title":"The pagination offset","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"title":"The pagination limit","default":100}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QueueRead"},"title":"Response Queues-Get Queues"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/queues/{queue_id}":{"get":{"tags":["queues"],"summary":"Get Queue","description":"Get a queue by its id.\n\n:param queue_id: id of the queue to retrieve","operationId":"queues-get_queue","parameters":[{"name":"queue_id","in":"path","required":true,"schema":{"type":"integer","title":"Queue Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/jobs":{"post":{"tags":["jobs"],"summary":"Create Job","description":"Create a new job.\n\n:param job: The job to create","operationId":"jobs-create_job","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Jobs-Create Job"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"get":{"tags":["jobs"],"summary":"Get Jobs","description":"Get all jobs using filter.\n\n:param filter: OData filter to filter jobs\n:param offset: items to skip\n:param limit: number of items to retrieve","operationId":"jobs-get_jobs","parameters":[{"name":"filter_exp","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter Exp"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobRead"},"title":"Response Jobs-Get Jobs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/jobs/{job_id}":{"get":{"tags":["jobs"],"summary":"Get Job","description":"Get a job by its id.\n\n:param job_id: id of the job to retrieve","operationId":"jobs-get_job","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"integer","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/jobs/{job_id}/status":{"get":{"tags":["jobs"],"summary":"Get Job Status","description":"Get job status by its id.\n\n:param job_id: id of the job to retrieve","operationId":"jobs-get_job_status","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"integer","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStatusEnum"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/jobs/{job_id}/clean":{"post":{"tags":["jobs"],"summary":"Clean Job","description":"Clean job resources.\n\n:param job_id: id of the job to clean","operationId":"jobs-clean_job","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"integer","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/plugins":{"get":{"tags":["plugins"],"summary":"Get Plugins","description":"Get all plugins.","operationId":"plugins-get_plugins","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PluginConfiguration"},"type":"array","title":"Response Plugins-Get Plugins"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["plugins"],"summary":"Register Plugin","description":"Register a new plugin.\n\n:param plugin: The plugin configuration","operationId":"plugins-register_plugin","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PluginConfiguration"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PluginConfiguration"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/applications":{"get":{"tags":["applications"],"summary":"Get Applications","description":"Get applications.","operationId":"applications-get_applications","parameters":[{"name":"filter_exp","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter expression","description":"The expression must be compatible with OData"},"description":"The expression must be compatible with OData"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","title":"The pagination offset","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"title":"The pagination limit","default":100}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationRead"},"title":"Response Applications-Get Applications"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["applications"],"summary":"Create Application","description":"Creates a new application.\n\n:param application: The application to create","operationId":"applications-create_application","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Applications-Create Application"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"put":{"tags":["applications"],"summary":"Update Application","description":"Updates an application.\n\n:param application: The application to update","operationId":"applications-update_application","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Applications-Update Application"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/applications/{app_id}":{"get":{"tags":["applications"],"summary":"Get Application","description":"Gets application by its id.\n\n:param app_id: id of the application","operationId":"applications-get_application","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"integer","title":"App Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/app-runtime-config/application/{app_id}":{"get":{"tags":["app-runtime-config"],"summary":"Get App Runtime Configs For Application","description":"Get all queues registered for given application id.\n\nIt retrieves the queues for the provided application from AppRuntimeConfig Model.\n\n:param app_id: Optional field if provided returns the registered queues for given application\n:param filter_exp: OData filter to filter queues\n:param offset: items to skip\n:param limit: number of items to retrieve","operationId":"app-runtime-config-get_app_runtime_configs_for_application","parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"integer","title":"App Id"}},{"name":"filter_exp","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter expression","description":"The expression must be compatible with OData"},"description":"The expression must be compatible with OData"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","title":"The pagination offset","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"title":"The pagination limit","default":100}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRuntimeConfigRead"},"title":"Response App-Runtime-Config-Get App Runtime Configs For Application"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/app-runtime-config":{"get":{"tags":["app-runtime-config"],"summary":"Get App Runtime Config","description":"Get application queue for given queue id and application id.\n\n:param queue_id: queue id\n:param app_id: application id","operationId":"app-runtime-config-get_app_runtime_config","parameters":[{"name":"queue_id","in":"query","required":true,"schema":{"type":"integer","title":"Queue Id"}},{"name":"app_id","in":"query","required":true,"schema":{"type":"integer","title":"App Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRuntimeConfigRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/app-runtime-config/{queue_id}/application/{app_id}":{"post":{"tags":["app-runtime-config"],"summary":"Register Application To Queue","description":"Registers an application to the provided queue.\n\n:param queue_id: The queue where the application will be registered\n:param app_id: The application to register","operationId":"app-runtime-config-register_application_to_queue","parameters":[{"name":"queue_id","in":"path","required":true,"schema":{"type":"integer","title":"Queue Id"}},{"name":"app_id","in":"path","required":true,"schema":{"type":"integer","title":"App Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRuntimeConfigCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response App-Runtime-Config-Register Application To Queue"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"put":{"tags":["app-runtime-config"],"summary":"Update Application To Queue","description":"Update an application to the provided queue.\n\n:param queue_id: The queue where the application will be registered\n:param app_id: The application to update","operationId":"app-runtime-config-update_application_to_queue","parameters":[{"name":"queue_id","in":"path","required":true,"schema":{"type":"integer","title":"Queue Id"}},{"name":"app_id","in":"path","required":true,"schema":{"type":"integer","title":"App Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRuntimeConfigCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response App-Runtime-Config-Update Application To Queue"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}}},"components":{"schemas":{"AppRuntimeConfigAttributes":{"properties":{"image":{"type":"string","title":"Image"},"working_dir":{"type":"string","title":"Working Dir"},"mount":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Mount"},"network":{"type":"string","title":"Network"},"ports":{"items":{"type":"integer"},"type":"array","title":"Ports"}},"type":"object","title":"AppRuntimeConfigAttributes","description":"Attribute definition for AppRuntimeConfig data model."},"AppRuntimeConfigCreate":{"properties":{"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"default_resources":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"attributes":{"anyOf":[{"$ref":"#/components/schemas/AppRuntimeConfigAttributes"},{"type":"null"}]},"service_port":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Service Port"}},"type":"object","title":"AppRuntimeConfigCreate","description":"AppRuntimeConfig definition for creation."},"AppRuntimeConfigRead":{"properties":{"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"default_resources":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"attributes":{"anyOf":[{"$ref":"#/components/schemas/AppRuntimeConfigAttributes"},{"type":"null"}]},"service_port":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Service Port"},"app_id":{"type":"integer","title":"App Id"},"queue_id":{"type":"integer","title":"Queue Id"},"application":{"$ref":"#/components/schemas/ApplicationRead"},"queue":{"$ref":"#/components/schemas/QueueRead"}},"type":"object","required":["app_id","queue_id","application","queue"],"title":"AppRuntimeConfigRead","description":"Public application queue definition."},"ApplicationAttributes":{"properties":{"kpis":{"items":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object"},"type":"array","title":"Kpis"},"assets":{"items":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object"},"type":"array","title":"Assets"},"solver_settings":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Solver Settings"}},"type":"object","title":"ApplicationAttributes","description":"Attribute definition for Application data model."},"ApplicationCreate":{"properties":{"name":{"type":"string","title":"Name"},"version":{"type":"string","title":"Version"},"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"parent":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent"},"application_type":{"type":"string","title":"Application Type"},"attributes":{"anyOf":[{"$ref":"#/components/schemas/ApplicationAttributes"},{"type":"null"}]}},"type":"object","required":["name","version"],"title":"ApplicationCreate","description":"Application definition for creation."},"ApplicationRead":{"properties":{"name":{"type":"string","title":"Name"},"version":{"type":"string","title":"Version"},"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"parent":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent"},"application_type":{"type":"string","title":"Application Type"},"attributes":{"anyOf":[{"$ref":"#/components/schemas/ApplicationAttributes"},{"type":"null"}]},"id":{"type":"integer","title":"Id"}},"type":"object","required":["name","version","id"],"title":"ApplicationRead","description":"Public application definition."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"JobCreate":{"properties":{"name":{"type":"string","title":"Name"},"queue_id":{"type":"integer","title":"Queue Id"},"parent_job_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent Job Id"},"application_id":{"type":"integer","title":"Application Id"},"arguments":{"items":{"type":"string"},"type":"array","title":"Arguments","default":[]},"replica_count":{"type":"integer","title":"Replica Count","default":1},"auto_clean":{"type":"boolean","title":"Auto Clean","default":false},"resources_requested":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"labels":{"additionalProperties":{"type":"string"},"type":"object","title":"Labels","default":{}},"attributes":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Attributes","default":{}}},"type":"object","required":["name","queue_id","application_id"],"title":"JobCreate","description":"Job definition on creation."},"JobRead":{"properties":{"name":{"type":"string","title":"Name"},"queue_id":{"type":"integer","title":"Queue Id"},"parent_job_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent Job Id"},"application_id":{"type":"integer","title":"Application Id"},"arguments":{"items":{"type":"string"},"type":"array","title":"Arguments","default":[]},"replica_count":{"type":"integer","title":"Replica Count","default":1},"auto_clean":{"type":"boolean","title":"Auto Clean","default":false},"resources_requested":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"labels":{"additionalProperties":{"type":"string"},"type":"object","title":"Labels","default":{}},"attributes":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Attributes","default":{}},"id":{"type":"integer","title":"Id"},"internal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Id"},"status":{"$ref":"#/components/schemas/JobStatusEnum"},"cleaned":{"type":"boolean","title":"Cleaned"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"status_updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Status Updated At"},"failed_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failed Reason"}},"type":"object","required":["name","queue_id","application_id","id","internal_id","status","cleaned","created_at","status_updated_at","failed_reason"],"title":"JobRead","description":"Public job definition."},"JobStatusEnum":{"type":"string","enum":["pending","running","failed","succeeded"],"title":"JobStatusEnum","description":"Enum of job status."},"JsonValue":{},"PluginConfiguration":{"properties":{"name":{"type":"string","title":"Name"},"module_name":{"type":"string","title":"Module Name"},"class_name":{"type":"string","title":"Class Name"},"attributes":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Attributes","default":{}}},"type":"object","required":["name","module_name","class_name"],"title":"PluginConfiguration","description":"Plugin configuration."},"QueueCreate":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"plugin":{"type":"string","title":"Plugin"},"working_dir":{"type":"string","title":"Working Dir","default":"/jobs"},"default_resources":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"maximum_resources":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"attributes":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Attributes","default":{}},"storages":{"items":{"$ref":"#/components/schemas/JsonValue"},"type":"array","title":"Storages","default":[]},"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}}},"type":"object","required":["name","description","plugin"],"title":"QueueCreate","description":"Queue definition for creation."},"QueueRead":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"plugin":{"type":"string","title":"Plugin"},"working_dir":{"type":"string","title":"Working Dir","default":"/jobs"},"default_resources":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"maximum_resources":{"anyOf":[{"$ref":"#/components/schemas/ResourcesDefinition"},{"type":"null"}]},"attributes":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Attributes","default":{}},"storages":{"items":{"$ref":"#/components/schemas/JsonValue"},"type":"array","title":"Storages","default":[]},"env":{"additionalProperties":{"type":"string"},"type":"object","title":"Env","default":{}},"id":{"type":"integer","title":"Id"}},"type":"object","required":["name","description","plugin","id"],"title":"QueueRead","description":"Public queue definition."},"ResourcesDefinition":{"properties":{"cpu":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cpu"},"memory_gb":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Memory Gb"}},"type":"object","title":"ResourcesDefinition","description":"Resource definition."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} \ No newline at end of file diff --git a/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/intro_archv2_.md b/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/intro_archv2_resources_api.md similarity index 61% rename from 2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/intro_archv2_.md rename to 2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/intro_archv2_resources_api.md index 7015c46c3f..0467dc68a0 100644 --- a/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/intro_archv2_.md +++ b/2025R2/AVX_Autonomy_REST_API_25R2/AVX_Explore_Resources_API_V1_ArchV2/intro_archv2_resources_api.md @@ -1,12 +1,28 @@ -# AVx Python APIs Documentation -## Background +## Features -The AVx python APIs are hosted as a python package on cluster as part of the Explore service deployment. The developers can install the package using pip and use it to call AVx autonomy APIs without the need to make raw REST calls. +This API allows to perform CRUD (Create, Read, Update, and Delete) operations on resources such as queues, deployments, applications and app-runtime-configurations. + +### Queues: +* You can create queues with the required storages, resource limits and environment variables +* Allowing to manage queues helps will help you configure different applications within resource limits and group the applications requiring same storage together. +* You can adjust the maximum number of workers that can concurrently run on a queue using the parameter 'maximum_allowed_worker_instances' + +### Plugins: +* You can register a plugin with definition of container runtime. +For example: Docker Engine / Kubernetes + +### Jobs: +* You can submit a resource-manager job by providing application details (name, version, image, environment variables, etc.) and track it to its completion. +You can also check the status of the job and clean the resources the job has acquired. + +## Introduction + +The AVxcelerate python APIs are hosted as a python package on a cluster as part of the Explore service deployment. The developers can install the package using pip and use it to call AVx autonomy APIs without needing to make raw REST calls. PyPi Regsitry URL: -The python package is hosted as PyPi compliant registry on each deployed cluster. The registry URL looks like this: +The python package is hosted as PyPi compliant registry on each deployed cluster. The registry URL is like this: https://BASE_URL/pypi @@ -18,7 +34,7 @@ For example, for AFT deployment: Pre-requisites: -We are assuming that on the system is running **Ubuntu 22.04**, there are following already installed: +We assume that on the system is running with the **Ubuntu 22.04** version, and that the following tools are already installed: - python 3.10 - pip 25.1 @@ -28,13 +44,13 @@ And we assume that you are using AVx Autonomy Toolchain version **25R2.1** Step 1: Create virtual environment -``` +```bash $ python -m venv .venv ``` Step 2: Activate the virtual environment -``` +```bash $ source .venv/bin/activate ``` @@ -43,13 +59,14 @@ Step 3: Install python packages: - ansys-api-avxcelerate-autonomy - ansys-avxcelerate-autonomy -``` +```bash $ pip install ansys-api-avxcelerate-autonomy ansys-avxcelerate-autonomy --extra-index-url [https://explore-service.traefik.me:9081/pypi](https://explore-service.traefik.me:9081/v1/pypi) +``` Step 4: Use ansys-api-avxcelerate-autonomy and ansys-avxcelerate-autonomy in your python code -``` -``` + +```python import asyncio from ansys.api.avxcelerate.autonomy.explore_service.v1.api.jobs_api import JobsApi @@ -105,4 +122,5 @@ print(str(ex)) print("Couldn't get job against this job id") asyncio.run(main()) -``` \ No newline at end of file +``` + diff --git a/2025R2/dpf-framework-25-r2/core-concepts/dpf-types.md b/2025R2/dpf-framework-25-r2/core-concepts/dpf-types.md index 78d74f0ab0..11b0e9d75b 100644 --- a/2025R2/dpf-framework-25-r2/core-concepts/dpf-types.md +++ b/2025R2/dpf-framework-25-r2/core-concepts/dpf-types.md @@ -63,10 +63,10 @@ The ``data_sources`` holds information on files of interest such as: - their associated namespace - their associated key (usually the file extension) -#### Streaming - +#### Streaming + The ``streams_container`` is the result of opening a stream to files in a ``data_sources``. It enables streaming to and from the files and handles caching of data requests to the files. @@ -76,40 +76,41 @@ The use of a ``streams_container`` is highly recommended whenever possible to be The following DPF objects hold light-weight data (metadata) relative to other DPF types. -#### Field metadata - -The ``field_definition`` holds metadata relative to a ``field``. +#### Field metadata -#### Mesh metadata +The ``field_definition`` holds metadata relative to a ``field``. +#### Mesh metadata + The ``mesh_info`` holds metadata relative to a ``meshed_region``. Only available for CFF and LSDYNA. -#### Result file metadata - -The ``result_info`` holds metadata relative to available results in files from a ``data_sources``. +#### Result file metadata -### Data supports +The ``result_info`` holds metadata relative to available results in files from a ``data_sources``. +### Data supports + Supports are entities dedicated to holding information about the model itself. Every ``field`` requires a ``support`` for DPF to understand what its data is related to. This concept allows DPF to manage simulation data efficiently. -#### Mesh +#### Mesh + The ``meshed_region`` holds information relative to the mesh of the simulation model. It gives access to several fields of data such as: @@ -117,17 +118,17 @@ It gives access to several fields of data such as: - the node coordinates - the element types -#### Time and frequency - +#### Time and frequency + For time and pseudo time based simulations or for frequency based simulations, the ``time_freq_support`` holds information about the simulation steps and sub-steps, time-steps, or mode/harmonic frequencies. -#### Cyclic - +#### Cyclic + For cyclic simulation models, the ``cyclic_support`` holds information about the number of sectors and the number of stages. ### Filtering @@ -156,10 +157,10 @@ Each ``field`` data storage type has a ``scoping`` associated to it, describing The following DPF types allow you to store and describe data. -#### Data map - +#### Data map + The ``generic_data_container`` allows you to store any type known to DPF as a property with a given name. #### Data tree @@ -168,10 +169,10 @@ The ``generic_data_container`` allows you to store any type known to DPF as a pr The ``data_tree`` allows you to store DPF known types as named attributes of a data tree with sub-trees. -#### Data arrays - +#### Data arrays + The following types represent arrays of data. The data of a ``field`` is always associated to a ``scoping`` (entities associated to each value) and ``support`` (subset of the model where the data is), making the ``field`` a self-describing piece of data. @@ -180,28 +181,28 @@ Example 1: a ``field`` that describes the evolution in time of the static pressu Example 2: a ``field`` that describes the evolution in space of the stress at a given body of a structural model has a scoping comprised of the element ids where the stress is defined and a ``meshed_region`` support that contextualizes these element ids. -##### Doubles - -The ``field`` represents an array of double values. +##### Doubles -##### Integers +The ``field`` represents an array of double values. -The ``property_field`` represents an array of integer values. +##### Integers -##### Strings +The ``property_field`` represents an array of integer values. -The ``string_field`` represents an array of string values. +##### Strings -##### Custom +The ``string_field`` represents an array of string values. +##### Custom + The ``custom_type_field`` represents an array of values of a custom type as defined by the unitary type of the field. ### Collections @@ -213,6 +214,7 @@ DPF allows you to group DPF types in labeled collections. A DPF ``collection`` has a set of associated labels, for which each entry has a value. This allows you to distinguish between entries and retrieve them. #### Label space + The ``label_space`` is a map of ("label": integer value) couples used to target a subset of entries in a collection. @@ -221,46 +223,46 @@ For example, if a ``collection`` has labels ``material`` and ``part``, each enti A ``label_space`` such as ``{"material": X, "part": Y}`` then targets a single entity in the collection, whereas one such as ``{"material": X}`` targets all entries of material "X". -#### Base collection - -The ``collection`` is the generic type for collections of DPF entities. +#### Base collection -#### Collection of any +The ``collection`` is the generic type for collections of DPF entities. -The ``any_collection`` is a collection of ``Any`` objects. +#### Collection of any -#### Collection of fields of custom type +The ``any_collection`` is a collection of ``Any`` objects. -The ``custom_type_fields_container`` is a collection of ``custom_type_field`` instances. +#### Collection of fields of custom type -#### Collection of fields of doubles +The ``custom_type_fields_container`` is a collection of ``custom_type_field`` instances. -The ``fields_container`` is a collection of ``field`` instances. +#### Collection of fields of doubles -#### Collection of fields of integers +The ``fields_container`` is a collection of ``field`` instances. -The ``property_fields_container`` is a collection of ``property_field`` instances. +#### Collection of fields of integers -#### Collection of meshes +The ``property_fields_container`` is a collection of ``property_field`` instances. -The ``meshes_container`` is a collection of ``meshed_region`` instances. +#### Collection of meshes -#### Collection of scopings +The ``meshes_container`` is a collection of ``meshed_region`` instances. +#### Collection of scopings + The ``scopings_container`` is a collection of ``scoping`` instances. ### Unit systems diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_difference.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_difference.md index 899cee69b8..77628575eb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_difference.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_difference.md @@ -19,7 +19,7 @@ Transforms an Elemental Nodal or Nodal field into an Elemental field. Each eleme | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | average only on these entities | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 10| through_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The maximum elemental difference is taken through the different shell layers if true (default is false). | +| Pin 10| through_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The maximum elemental difference is taken through the different shell layers if true (default is false). | ## Outputs @@ -31,7 +31,7 @@ Transforms an Elemental Nodal or Nodal field into an Elemental field. Each eleme | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_difference_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_difference_fc.md index 343c7b027e..da89a581dd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_difference_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_difference_fc.md @@ -19,7 +19,7 @@ Transforms an Elemental Nodal or Nodal field into an Elemental field. Each eleme | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging, used if there is no fields support. | | Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Average only on these elements. If it is scoping container, the label must correspond to the one of the fields container. | -| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | ## Outputs @@ -31,9 +31,9 @@ Transforms an Elemental Nodal or Nodal field into an Elemental field. Each eleme | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_fraction_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_fraction_fc.md index 315483700d..6484c2dab1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_fraction_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_fraction_fc.md @@ -20,7 +20,7 @@ Transforms Elemental Nodal fields into Elemental fields. Each elemental value is | Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | | Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers. | | Pin 6| denominator |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | If a fields container is set in this pin, it is used as the denominator of the fraction instead of entity_average_fc. | -| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | ## Outputs @@ -32,9 +32,9 @@ Transforms Elemental Nodal fields into Elemental fields. Each elemental value is | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_mean.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_mean.md index 5e81607787..d79e46d8e6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_mean.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_mean.md @@ -17,8 +17,8 @@ Computes the average of a multi-entity field, (ElementalNodal -> Elemental), (No | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, shell layers are averaged as well (default is false). | -| Pin 2| force_averaging |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true you average, if false you just sum. | +| Pin 1| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, shell layers are averaged as well (default is false). | +| Pin 2| force_averaging |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true you average, if false you just sum. | | Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers. | ## Outputs @@ -31,7 +31,7 @@ Computes the average of a multi-entity field, (ElementalNodal -> Elemental), (No | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_mean_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_mean_fc.md index f2ad3a0bf5..57f0456e0e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_mean_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_mean_fc.md @@ -17,12 +17,12 @@ Computes the average of a multi-entity container of fields, (ElementalNodal -> E | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, the data across different shell layers is averaged as well (default is false). | -| Pin 2| force_averaging |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true you average, if false you just sum. | +| Pin 1| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 2| force_averaging |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true you average, if false you just sum. | | Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields container. | | Pin 4| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | -| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). This pin only has an effect when collapse_shell_layers is false and a value for e_shell_layer is provided. | -| Pin 27| e_shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false. | +| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). This pin only has an effect when collapse_shell_layers is false and a value for e_shell_layer is provided. | +| Pin 27| e_shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false. | ## Outputs @@ -34,7 +34,7 @@ Computes the average of a multi-entity container of fields, (ElementalNodal -> E | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal.md index 758d78037c..2b3be2c402 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal.md @@ -18,9 +18,9 @@ Transforms an Elemental Nodal field into a Nodal field using an averaging proces |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | average only on these entities | -| Pin 2| should_average |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Each nodal value is divided by the number of elements linked to this node (default is true for discrete quantities). | -| Pin 4| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Compute mid nodes (when available) by averaging the neighbour primary nodes. | -| Pin 5| extend_weights_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Extends weights to mid nodes (when available). Default is false. | +| Pin 2| should_average |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Each nodal value is divided by the number of elements linked to this node (default is true for discrete quantities). | +| Pin 4| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour primary nodes. | +| Pin 5| extend_weights_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Extends weights to mid nodes (when available). Default is false. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs @@ -34,7 +34,7 @@ Transforms an Elemental Nodal field into a Nodal field using an averaging proces | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md index 01187b9694..dcf9369612 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md @@ -29,7 +29,7 @@ Transforms an Elemental Nodal field to Nodal Elemental. The result is computed o | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md index b7608f0f96..2924f6f0a2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md @@ -29,9 +29,9 @@ Transforms Elemental Nodal fields to Nodal Elemental fields. The result is compu | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md index c17ee57505..902e224ba1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md @@ -18,12 +18,12 @@ Transforms Elemental Nodal fields into Nodal fields using an averaging process. |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | -| Pin 2| should_average |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Each nodal value is divided by the number of elements linked to this node (default is true for discrete quantities). | +| Pin 2| should_average |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Each nodal value is divided by the number of elements linked to this node (default is true for discrete quantities). | | Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Average only on these nodes. If it is a scoping container, the label must correspond to the one of the fields containers. | -| Pin 4| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Compute mid nodes (when available) by averaging the neighbour primary nodes. | -| Pin 5| extend_weights_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Extends weights to mid nodes (when available). Default is false. | -| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | +| Pin 4| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour primary nodes. | +| Pin 5| extend_weights_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Extends weights to mid nodes (when available). Default is false. | +| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | ## Outputs @@ -36,9 +36,9 @@ Transforms Elemental Nodal fields into Nodal fields using an averaging process. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_elemental_nodal.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_elemental_nodal.md index 008db73b18..d63a3aa6b6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_elemental_nodal.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_elemental_nodal.md @@ -30,7 +30,7 @@ Transforms an Elemental field to an Elemental Nodal field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md index 4460dfa5cb..13b53065d6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md @@ -30,7 +30,7 @@ Transforms Elemental field to Elemental Nodal field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_nodal.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_nodal.md index 256e8ab6f0..6d828eaf2f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_nodal.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_nodal.md @@ -27,8 +27,8 @@ Transforms an Elemental field to a Nodal field. The result is computed on a give |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 2| force_averaging |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Averaging on nodes is used if this pin is set to 1 (default is 1 for integrated results and 0 for discrete ones). | -| Pin 200| algorithm |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of mesh). | +| Pin 2| force_averaging |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Averaging on nodes is used if this pin is set to 1 (default is 1 for integrated results and 0 for discrete ones). | +| Pin 200| algorithm |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of mesh). | ## Outputs @@ -40,8 +40,8 @@ Transforms an Elemental field to a Nodal field. The result is computed on a give | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_nodal_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_nodal_fc.md index 49eac0ec0b..76752b179a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_nodal_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/elemental_to_nodal_fc.md @@ -25,9 +25,9 @@ Transforms Elemental Nodal fields to Nodal fields. The result is computed on a g |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 2| force_averaging |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Averaging on nodes is used if this pin is set to 1 (default is 1 for integrated results and 0 for discrete ones). | +| Pin 2| force_averaging |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Averaging on nodes is used if this pin is set to 1 (default is 1 for integrated results and 0 for discrete ones). | | Pin 3| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | | -| Pin 200| algorithm |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of mesh). | +| Pin 200| algorithm |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of mesh). | ## Outputs @@ -39,9 +39,9 @@ Transforms Elemental Nodal fields to Nodal fields. The result is computed on a g | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/extend_to_mid_nodes.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/extend_to_mid_nodes.md index cd5a05e453..f9c2727399 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/extend_to_mid_nodes.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/extend_to_mid_nodes.md @@ -29,8 +29,8 @@ Extends an Elemental Nodal or Nodal field defined on corner nodes to a field def | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this configuration is set to true. Only supported for nodal fields in input. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this configuration is set to true. Only supported for nodal fields in input. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/extend_to_mid_nodes_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/extend_to_mid_nodes_fc.md index 6d478ede87..7c1956d7a7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/extend_to_mid_nodes_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/extend_to_mid_nodes_fc.md @@ -29,10 +29,10 @@ Extends Elemental Nodal or Nodal fields defined on corner nodes to Elemental Nod | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this configuration is set to true. Only supported for nodal fields in input. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this configuration is set to true. Only supported for nodal fields in input. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/force_summation.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/force_summation.md index d83180389e..27617b61cb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/force_summation.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/force_summation.md @@ -16,12 +16,12 @@ Computes the sum of elemental forces contribution on a set of nodes in Global Co | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | default = all time steps | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | default = all time steps | | Pin 1| nodal_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes) | | Pin 2| elemental_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Elemental Scoping. Set of elements contributing to the force calcuation. (default = all elements) | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Streams container. Optional if using data sources. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources. Optional if using a streams container. | -| Pin 5| force_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Type of force to be processed (0 - default: Total forces (static, damping, and inertia)., 1: Static forces, 2: Damping forces, 3: Inertia forces) | +| Pin 5| force_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Type of force to be processed (0 - default: Total forces (static, damping, and inertia)., 1: Static forces, 2: Damping forces, 3: Inertia forces) | | Pin 6| spoint |[`field`](../../core-concepts/dpf-types.md#field) | Coordinate field of a point for moment summations. Defaults to (0,0,0). | ## Outputs @@ -39,7 +39,7 @@ Computes the sum of elemental forces contribution on a set of nodes in Global Co | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/force_summation_psd.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/force_summation_psd.md index 2a51775427..1645d37730 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/force_summation_psd.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/force_summation_psd.md @@ -22,7 +22,7 @@ Computes the sum of elemental forces contribution on a set of nodes in Global Co | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources containing RST and PSD files (optional if using a streams container). The operator supports both a single RST file (containing both modal and PSD results) and two separate RST files (one for modal and one for PSD analyses).The data source containing modal results must be defined as an upstream data source.If using a single RST file for PSD and modal analysis, the RST file must be in an upstream data source.If using two separate RST files, only the modal RST must be in an upstream data source. | | Pin 6| spoint |[`field`](../../core-concepts/dpf-types.md#field) | Coordinate field of a point for moment summations. Defaults to (0,0,0). | | Pin 7| abs_rel_key |[`field`](../../core-concepts/dpf-types.md#field) | Key to select the type of response: 0 for relative response (default) or 1 for absolute response. | -| Pin 8| signif |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Significance threshold, defaults to 0.0001. Any mode with a significance level above this value will be included in the combination.The significance level is defined as the modal covariance matrix term, divided by the maximum modal covariance matrix term. | +| Pin 8| signif |[`double`](../../core-concepts/dpf-types.md#standard-types) | Significance threshold, defaults to 0.0001. Any mode with a significance level above this value will be included in the combination.The significance level is defined as the modal covariance matrix term, divided by the maximum modal covariance matrix term. | ## Outputs @@ -37,7 +37,7 @@ Computes the sum of elemental forces contribution on a set of nodes in Global Co | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/gauss_to_node_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/gauss_to_node_fc.md index 6d087986de..fbe44365c2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/gauss_to_node_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/gauss_to_node_fc.md @@ -30,7 +30,7 @@ Extrapolates results available at Gauss or quadrature points to nodal points for | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_difference.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_difference.md index 13f7e4e9d8..cec8de6b95 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_difference.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_difference.md @@ -30,7 +30,7 @@ Transforms an Elemental Nodal field into a Nodal field. Each nodal value is the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_difference_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_difference_fc.md index e9b909cf79..669ab6e842 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_difference_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_difference_fc.md @@ -30,9 +30,9 @@ Transforms Elemental Nodal fields into Nodal fields. Each nodal value is the max | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_fraction_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_fraction_fc.md index a0367c26d5..d84469923a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_fraction_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_fraction_fc.md @@ -31,9 +31,9 @@ Transforms Elemental Nodal fields into Nodal fields. Each nodal value is the fra | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental.md index 4b03bb47c4..6057e86286 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental.md @@ -18,7 +18,7 @@ Transforms a Nodal field to an Elemental field, The result is computed on a give |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | ## Outputs @@ -30,7 +30,7 @@ Transforms a Nodal field to an Elemental field, The result is computed on a give | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental_fc.md index 8a3e17462b..87f63a0dd4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental_fc.md @@ -19,9 +19,9 @@ Transforms Nodal fields into Elemental fields using an averaging process. The re | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. | | Pin 3| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers. | -| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, the data across different shell layers is averaged as well (default is false). | -| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | +| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | ## Outputs @@ -33,9 +33,9 @@ Transforms Nodal fields into Elemental fields using an averaging process. The re | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental_nodal.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental_nodal.md index ac03f6e99d..5bfe9ee8d0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental_nodal.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental_nodal.md @@ -18,7 +18,7 @@ Transforms a Nodal field to an ElementalNodal field, The result is computed on a |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | ## Outputs @@ -30,7 +30,7 @@ Transforms a Nodal field to an ElementalNodal field, The result is computed on a | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md index ca868feaac..68fea1e99f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md @@ -30,7 +30,7 @@ Transforms Nodal fields_container to Elemental Nodal fields_container. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_elemental_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_elemental_fc.md index b360a0c996..dd998dce22 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_elemental_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_elemental_fc.md @@ -19,10 +19,10 @@ Transforms Input fields into Elemental fields using an averaging process. The re | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 3| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 7| smoothen_values |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if it is set to true, Elemental Nodal fields are first averaged on nodes and then averaged on elements (default is false). | -| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, the data across different shell layers is averaged as well (default is false). | -| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | +| Pin 7| smoothen_values |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if it is set to true, Elemental Nodal fields are first averaged on nodes and then averaged on elements (default is false). | +| Pin 10| collapse_shell_layers |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the data across different shell layers is averaged as well (default is false). | +| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | ## Outputs @@ -34,9 +34,9 @@ Transforms Input fields into Elemental fields using an averaging process. The re | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_elemental_nodal_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_elemental_nodal_fc.md index 892c0c6226..d84abd713d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_elemental_nodal_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_elemental_nodal_fc.md @@ -30,9 +30,9 @@ Transforms fields into Elemental Nodal fields using an averaging process. The re | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_nodal.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_nodal.md index 145c7e9380..c7a10b088f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_nodal.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_nodal.md @@ -18,8 +18,8 @@ Transforms a field into a Nodal field using an averaging process. The result is |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | +| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | ## Outputs @@ -31,7 +31,7 @@ Transforms a field into a Nodal field using an averaging process. The result is | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_nodal_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_nodal_fc.md index 9e7876854a..46bf41f7af 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_nodal_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/averaging/to_nodal_fc.md @@ -19,8 +19,8 @@ Transforms fields into Nodal fields using an averaging process. The result is co | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 3| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | +| Pin 26| merge_solid_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid). | ## Outputs @@ -32,9 +32,9 @@ Transforms fields into Nodal fields using an averaging process. The result is co | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/add_default_data.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/add_default_data.md index e0490e645e..5bc03a876e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/add_default_data.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/add_default_data.md @@ -16,7 +16,7 @@ Adds the defaults to the elements which were removed by the lay-up provider from | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_id |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | requested_time_id | +| Pin 0
Required| time_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | requested_time_id | | Pin 1
Required| requested_element_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | requested_element_scoping | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh | | Pin 300
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields container to which default values are added | @@ -30,7 +30,7 @@ Adds the defaults to the elements which were removed by the lay-up provider from | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/composite_failure_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/composite_failure_operator.md index fff08515bc..4a4cfa1dab 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/composite_failure_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/composite_failure_operator.md @@ -16,8 +16,8 @@ Uses json failure configuration to compute evaluate composite failure criterion. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 100
Required| result_definition |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Combined failure criterion configuration (string of json dict) | -| Pin 310| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}) | Default unit system. Used if the result file specifies no unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 100
Required| result_definition |[`string`](../../core-concepts/dpf-types.md#standard-types) | Combined failure criterion configuration (string of json dict) | +| Pin 310| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Default unit system. Used if the result file specifies no unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | ## Outputs @@ -33,7 +33,7 @@ Uses json failure configuration to compute evaluate composite failure criterion. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/composite_field_variable_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/composite_field_variable_operator.md index d4e7018b6a..70de9ecd5d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/composite_field_variable_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/composite_field_variable_operator.md @@ -20,7 +20,7 @@ Enriches the materials container with the material fields (field variable) from | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 22
Required| material_fields |umap | | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -31,7 +31,7 @@ Enriches the materials container with the material fields (field variable) from | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/composite_scoping_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/composite_scoping_operator.md index 1c99e2aa7f..7c09268b0f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/composite_scoping_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/composite_scoping_operator.md @@ -18,7 +18,7 @@ Computes scoping based on ply and element scope |-------|-------|------------------|-------------| | Pin 1
Required| element_scope |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Optional: CScoping with selected element ids. | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 105
Required| ply_scope |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Optional: vector of selected ply ids. | +| Pin 105
Required| ply_scope |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Optional: vector of selected ply ids. | ## Outputs @@ -29,7 +29,7 @@ Computes scoping based on ply and element scope | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/convert_sampling_point_to_json.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/convert_sampling_point_to_json.md index b05ff3c9aa..4d4006f65c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/convert_sampling_point_to_json.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/convert_sampling_point_to_json.md @@ -22,13 +22,13 @@ Converts a sampling point object into a sampling point json string. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| string |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Sampling point json | +| **Pin 0**| string |[`string`](../../core-concepts/dpf-types.md#standard-types) | Sampling point json | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/core_shear_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/core_shear_operator.md index 3850bf2701..ddbd25de12 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/core_shear_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/core_shear_operator.md @@ -18,9 +18,9 @@ Computes Core Shear for ElementalNodal data |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification (json dict as string): For instance "{"active": true, "include_ins" : true, "wf" : 1}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, only computes failure criteria for ply types 'orthotropic_homogeneous_core', 'isotropic_homogeneous_core', 'honeycomb_core' | -| Pin 102
Required| mesh |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "include_ins" : true, "wf" : 1}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'orthotropic_homogeneous_core', 'isotropic_homogeneous_core', 'honeycomb_core' | +| Pin 102
Required| mesh |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs @@ -33,7 +33,7 @@ Computes Core Shear for ElementalNodal data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/cuntze_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/cuntze_operator.md index 3f76f60252..9b50735f4e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/cuntze_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/cuntze_operator.md @@ -18,9 +18,9 @@ Computes Cuntze's failure criterion for ElementalNodal data |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification (json dict as string): For instance "{"b21": 0.2, "b32": 1.38, "cfc": true, "cft": true, "cma": true, "cmb": true, "cmc": true, "dim": 2, "fracture_plane_angle": 53, "mode_interaction_coeff": 2.6, "wf_cfc": 1, "wf_cft": 1, "wf_cma": 1, "wf_cmb": 1, "wf_cmc": 1}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, only computes failure criteria for ply type 'isotropic' | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"b21": 0.2, "b32": 1.38, "cfc": true, "cft": true, "cma": true, "cmb": true, "cmc": true, "dim": 2, "fracture_plane_angle": 53, "mode_interaction_coeff": 2.6, "wf_cfc": 1, "wf_cft": 1, "wf_cma": 1, "wf_cmb": 1, "wf_cmc": 1}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | @@ -34,7 +34,7 @@ Computes Cuntze's failure criterion for ElementalNodal data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/evaluate_failure_criterion_per_scope.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/evaluate_failure_criterion_per_scope.md index 356829346e..5584ac428f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/evaluate_failure_criterion_per_scope.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/evaluate_failure_criterion_per_scope.md @@ -23,11 +23,11 @@ Evaluates failure criteria for a specified scope. | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | | Pin 24| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section Data Container: Only needed if has_layup_provider is true | | Pin 25| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Mesh Properties Container Container: Only needed if has_layup_provider is true | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Failure criteria configuration | -| Pin 217
Required| has_layup_provider |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Deprecated since 2024 R2. Use input pin 218instead. Should be set to true if layup information is available. Equivalent new input is ACP (1). | -| Pin 218
Required| layup_model_context_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Define the source of section data. Values are: 0=not available, 1=ACP, 2=RST, 3=MIXED (ACP+RST). | -| Pin 302
Required| request_sandwich_results |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Request results for sandwich failure criteria. | -| Pin 303| use_live_evaluation |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Use live evaluation. Default: False | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Failure criteria configuration | +| Pin 217
Required| has_layup_provider |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Deprecated since 2024 R2. Use input pin 218instead. Should be set to true if layup information is available. Equivalent new input is ACP (1). | +| Pin 218
Required| layup_model_context_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Define the source of section data. Values are: 0=not available, 1=ACP, 2=RST, 3=MIXED (ACP+RST). | +| Pin 302
Required| request_sandwich_results |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Request results for sandwich failure criteria. | +| Pin 303| use_live_evaluation |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Use live evaluation. Default: False | | Pin 307
Required| scope_configuration |struct dataProcessing::composite::CompositeScopeConfig | Scope configuration | ## Outputs @@ -35,7 +35,7 @@ Evaluates failure criteria for a specified scope. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| | **Pin 304**| failure_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container with the failure results | -| **Pin 306**| time_id |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Requested time id | +| **Pin 306**| time_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Requested time id | | **Pin 400**| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container with the strains | | **Pin 401**| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container with the stresses | @@ -43,7 +43,7 @@ Evaluates failure criteria for a specified scope. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/evaluate_sampling_point.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/evaluate_sampling_point.md index 1a8c914d67..dcd8987bea 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/evaluate_sampling_point.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/evaluate_sampling_point.md @@ -22,10 +22,10 @@ Creates a sampling point object. | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials Container | | Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section data container | | Pin 304
Required| failure_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container that contains the failure values | -| Pin 306
Required| time_id |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | requested_time_id | -| Pin 308
Required| extract_max_failure_per_layer |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, extract maximum failure value per layer. Otherwise get max values per spot. | -| Pin 309
Required| check_mechanical_unit_system |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Check mechancial unit system. If true, checks that unit system is supported by mechanical | -| Pin 310
Required| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}) | Unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 306
Required| time_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | requested_time_id | +| Pin 308
Required| extract_max_failure_per_layer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, extract maximum failure value per layer. Otherwise get max values per spot. | +| Pin 309
Required| check_mechanical_unit_system |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Check mechancial unit system. If true, checks that unit system is supported by mechanical | +| Pin 310
Required| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | | Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Strains Container | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Stresses Container | @@ -39,7 +39,7 @@ Creates a sampling point object. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/face_sheet_wrinkling_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/face_sheet_wrinkling_operator.md index 22270acec5..e3dfcbb361 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/face_sheet_wrinkling_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/face_sheet_wrinkling_operator.md @@ -20,8 +20,8 @@ Computes face-sheet wrinkling criterion for layered elements. Use the composite: | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | | Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Layup Container with layer thicknesses, angles etc. | | Pin 25
Required| mesh_property_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Properties from the ACP model to compute Wrinkling for solids. Not needed to compute wrinkling for shells. | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification (json dict as string): For instance {"homogeneous_core_coeff" : 0.5, "honeycomb_core_coeff" : 0.33, "wf" : 1.0} | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance {"homogeneous_core_coeff" : 0.5, "honeycomb_core_coeff" : 0.33, "wf" : 1.0} | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs @@ -34,7 +34,7 @@ Computes face-sheet wrinkling criterion for layered elements. Use the composite: | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/failure_measure_converter.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/failure_measure_converter.md index 5e02b35f81..d14a4f7a40 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/failure_measure_converter.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/failure_measure_converter.md @@ -17,7 +17,7 @@ Conversion from one failure measure to another. Supported are inverse_reserve_fa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| measure_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | measure type: can be `inverse_reserve_factor` (default), `safety_factor` or `safety_margin`. | +| Pin 1
Required| measure_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | measure type: can be `inverse_reserve_factor` (default), `safety_factor` or `safety_margin`. | ## Outputs @@ -29,7 +29,7 @@ Conversion from one failure measure to another. Supported are inverse_reserve_fa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/filter_ply_data_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/filter_ply_data_operator.md index 385cdaa6d4..16fd90f8f4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/filter_ply_data_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/filter_ply_data_operator.md @@ -17,8 +17,8 @@ Selects a ply from layered elemental_nodal data and averages the data over the s | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | Elemental Nodal input field with layered data. Example are stress and strains fields as read from the rst file. | -| Pin 1
Required| ply_id |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Ply Id of the analysis ply that gets selected. | -| Pin 2
Required| reduction_strategy |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Reduction strategy for spot data (bot, mid, top) values. Available options: - AVG: average over spots (default) - MIN: take minimum value of all spots - MAX: take maximum value of all spots - BOT: take bottom value (only supported for shell elements if at least two spots are available in the output) - MID: take mid value (only supported for shell elements if at least three spots are available in the output) - TOP: take top value (only supported for shell elements if at least two spots are available in the output) | +| Pin 1
Required| ply_id |[`string`](../../core-concepts/dpf-types.md#standard-types) | Ply Id of the analysis ply that gets selected. | +| Pin 2
Required| reduction_strategy |[`string`](../../core-concepts/dpf-types.md#standard-types) | Reduction strategy for spot data (bot, mid, top) values. Available options: - AVG: average over spots (default) - MIN: take minimum value of all spots - MAX: take maximum value of all spots - BOT: take bottom value (only supported for shell elements if at least two spots are available in the output) - MID: take mid value (only supported for shell elements if at least three spots are available in the output) - TOP: take top value (only supported for shell elements if at least two spots are available in the output) | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed region with composite information. The mesh needs to have property field with the name 'element_layer_indices' whichcontains the number of layers for each element. It also needs to have a field with the name AnalysisPly::ply_id where ply_id is the ply_id as defined by pin 1. These two property fields are automatically added to the meshed region if the 'composite::layup_provider_operator'is run. | ## Outputs @@ -31,7 +31,7 @@ Selects a ply from layered elemental_nodal data and averages the data over the s | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/get_field_properties_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/get_field_properties_operator.md index 830d2efc6a..2fecd79061 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/get_field_properties_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/get_field_properties_operator.md @@ -28,7 +28,7 @@ Operator which returns all int, double and string properties as a data tree. Inp | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/hashin_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/hashin_operator.md index 850b9cb5b9..0207082d19 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/hashin_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/hashin_operator.md @@ -18,9 +18,9 @@ Computes hashin criterion for ElementalNodal data |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification (json dict as string): For instance "{"active": false, "dim" : 2, "hd" : false, "hf" : true, "hm" : true, "wf_hd" : 1, "wf_hf" : 1, "wf_hm" : 1}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, only computes failure criteria for ply type 'regular'. | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": false, "dim" : 2, "hd" : false, "hf" : true, "hm" : true, "wf_hd" : 1, "wf_hf" : 1, "wf_hm" : 1}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'regular'. | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Stress field | ## Outputs @@ -33,7 +33,7 @@ Computes hashin criterion for ElementalNodal data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/hill_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/hill_operator.md index 9b8fef9c11..e7a8d58b40 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/hill_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/hill_operator.md @@ -18,9 +18,9 @@ Computes Hill for ElementalNodal data |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification: For instance `{'active': true, 'dim': 2, 'wf': 1}` | -| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, only computes failure criteria for ply types 'woven' and 'regular' | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification: For instance `{'active': true, 'dim': 2, 'wf': 1}` | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Stress container | ## Outputs @@ -33,7 +33,7 @@ Computes Hill for ElementalNodal data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/hoffman_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/hoffman_operator.md index d442c7ad78..ed92fdfd7f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/hoffman_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/hoffman_operator.md @@ -18,9 +18,9 @@ Computes Hoffman for ElementalNodal data |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, only computes failure criteria for ply types 'woven' and 'regular' | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs @@ -33,7 +33,7 @@ Computes Hoffman for ElementalNodal data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/inistate_field_variable_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/inistate_field_variable_operator.md index ab71dfe191..f1eccff5bf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/inistate_field_variable_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/inistate_field_variable_operator.md @@ -31,7 +31,7 @@ Extracts field variables from an APDL input file (dat) | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/interlaminar_normal_stress_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/interlaminar_normal_stress_operator.md index 5fab9acc16..5d1310ebf0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/interlaminar_normal_stress_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/interlaminar_normal_stress_operator.md @@ -20,7 +20,7 @@ Computes the interlaminar normal stresses and updates the stress container | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials Container | | Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section data fields container | | Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Mesh property fields container | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to check if all the inputs have the same meshed region. This check can become expensive | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Whether to check if all the inputs have the same meshed region. This check can become expensive | | Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Strains | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Stresses | @@ -33,7 +33,7 @@ Computes the interlaminar normal stresses and updates the stress container | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/larc_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/larc_operator.md index 4fafbcb0ff..8190db2e34 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/larc_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/larc_operator.md @@ -19,9 +19,9 @@ Computes Larc for ElementalNodal data | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | | Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Layup Container with layer thicknesses, angles etc. | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification (json dict as string): For instance {"active": True, "dim" : 2, "lfc" : True, "lft" : True, "lmc" : True, "lmt" : True, "wf_lfc" : 1, "wf_lft" : 1, "wf_lmc" : 1, "wf_lmt" : 1} | -| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, only computes failure criteria for ply type 'isotropic' | -| Pin 102
Required| bool |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance {"active": True, "dim" : 2, "lfc" : True, "lft" : True, "lmc" : True, "lmt" : True, "wf_lfc" : 1, "wf_lft" : 1, "wf_lmc" : 1, "wf_lmt" : 1} | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | +| Pin 102
Required| bool |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | @@ -35,7 +35,7 @@ Computes Larc for ElementalNodal data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/layup_provider_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/layup_provider_operator.md index 41c5252666..5451457110 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/layup_provider_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/layup_provider_operator.md @@ -20,23 +20,23 @@ Import section data from ACP's composite definition files and/or | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | DataSource of composite definitions (h5) files with mapping files to import lay-up information with additional ACP specific information. Use the sResultKey to name the parts. | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 21
Required| abstract_field_support |[`abstract_field_support`](../../core-concepts/dpf-types.md#field-support) | The material support originating from an RST file. | -| Pin 310
Required| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}) | Layup quantities are converted into this unit system. Can be unit system object, result_info object int or string. In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 310
Required| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Layup quantities are converted into this unit system. Can be unit system object, result_info object int or string. In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| update |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Request this output to run the operator. Returns always true. Only useful in a workflow context whereexplicit runs are not possible. | +| **Pin 0**| update |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Request this output to run the operator. Returns always true. Only useful in a workflow context whereexplicit runs are not possible. | | **Pin 22**| material_fields |umap | A unordered map with key the variable material field name and value the corresponding ImportedMaterialField struct. | | **Pin 24**| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldContainer containing the angles, the thicknesses and the laminate offset of each layer. | | **Pin 25**| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A CFieldContainer containing mesh properties (curvature, element edge length etc.). Only available if composite definitions are passed to the input. | -| **Pin 218**| layup_model_context_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Returns the type of lay-up model. 0=Not available, 1=ACP, 2=RST, 3=Mixed. Mixed means that section data from ACP and the RST file were imported. | +| **Pin 218**| layup_model_context_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Returns the type of lay-up model. 0=Not available, 1=ACP, 2=RST, 3=Mixed. Mixed means that section data from ACP and the RST file were imported. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/ls_dyna_keyword_parser.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/ls_dyna_keyword_parser.md index c3445c1f48..2d74586005 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/ls_dyna_keyword_parser.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/ls_dyna_keyword_parser.md @@ -25,20 +25,20 @@ Reads a specific keyword from an k-file. The parser reads the name of the option | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| keyword |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | The keyword of interest. For instance '*DATABASE_EXTENT_BINARY'. | +| Pin 0
Required| keyword |[`string`](../../core-concepts/dpf-types.md#standard-types) | The keyword of interest. For instance '*DATABASE_EXTENT_BINARY'. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | LS Dyna input file (*.k) as data source. Use LsDynaInputFile as key to add a k-file to the DataSources object. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| keyword_options |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | JSON string with all the options. For instance '{"neiph": 0, "neips": 16, ...}' | +| **Pin 0**| keyword_options |[`string`](../../core-concepts/dpf-types.md#standard-types) | JSON string with all the options. For instance '{"neiph": 0, "neips": 16, ...}' | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/ls_dyna_material_support_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/ls_dyna_material_support_provider.md index 0fc09cf44e..e805510b8e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/ls_dyna_material_support_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/ls_dyna_material_support_provider.md @@ -28,7 +28,7 @@ Extracts the material IDs and VUUIDs from a k file and provides a material suppo | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/ls_dyna_preparing_results.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/ls_dyna_preparing_results.md index 829a77558f..a43b8317d1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/ls_dyna_preparing_results.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/ls_dyna_preparing_results.md @@ -16,7 +16,7 @@ Remove unused result (integration points).The number of integration points in th | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| maxint |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | The value of MAXINT. | +| Pin 0
Required| maxint |[`int32`](../../core-concepts/dpf-types.md#standard-types) | The value of MAXINT. | | Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Result container. For instance strains or stresses. | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Enriched meshed region with section information such as number of layers. See 'composite::layup_provider_operator' for more information. | @@ -30,7 +30,7 @@ Remove unused result (integration points).The number of integration points in th | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/map_to_reference_surface_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/map_to_reference_surface_operator.md index 641a02648a..b3c340e761 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/map_to_reference_surface_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/map_to_reference_surface_operator.md @@ -33,7 +33,7 @@ Maps values from a min and max field container, according to a mapping defined i | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/max_over_multiple_failure_criteria_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/max_over_multiple_failure_criteria_operator.md index 2d9082e3e0..56fe8a7a50 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/max_over_multiple_failure_criteria_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/max_over_multiple_failure_criteria_operator.md @@ -28,7 +28,7 @@ Computes max failure criterion for all the input criterion per ElementalNodal da | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/max_strain_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/max_strain_operator.md index 1ee7a789f3..c7546a78a7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/max_strain_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/max_strain_operator.md @@ -18,9 +18,9 @@ Computes max strain for ElementalNodal data |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification: For instance {"active": true, "e1": true, "e12": true, "e13": false, "e2": true, "e23": false, "e3": false, "eSxy": 0, "eSxz": 0, "eSyz": 0, "eXc": 0, "eXt": 0, "eYc": 0, "eYt": 0, "eZc": 0, "eZt": 0, "force_global_strain_limits": false, "wf_e1": 1, "wf_e12": 1, "wf_e13": 1, "wf_e2": 1, "wf_e23": 1, "wf_e3": 1} | -| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, only computes failure criteria for ply types 'woven' and 'regular' | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification: For instance {"active": true, "e1": true, "e12": true, "e13": false, "e2": true, "e23": false, "e3": false, "eSxy": 0, "eSxz": 0, "eSyz": 0, "eXc": 0, "eXt": 0, "eYc": 0, "eYt": 0, "eZc": 0, "eZt": 0, "force_global_strain_limits": false, "wf_e1": 1, "wf_e12": 1, "wf_e13": 1, "wf_e2": 1, "wf_e23": 1, "wf_e3": 1} | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs @@ -33,7 +33,7 @@ Computes max strain for ElementalNodal data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/mechanical_sampling_point_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/mechanical_sampling_point_operator.md index db9ced515e..c10744c371 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/mechanical_sampling_point_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/mechanical_sampling_point_operator.md @@ -16,20 +16,20 @@ Uses json failure configuration to compute evaluate composite sampling point. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 100
Required| result_definition |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Combined sampling point configuration (string of json dict | -| Pin 310| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}) | Default unit system. Used if the result file specifies no unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | +| Pin 100
Required| result_definition |[`string`](../../core-concepts/dpf-types.md#standard-types) | Combined sampling point configuration (string of json dict | +| Pin 310| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Default unit system. Used if the result file specifies no unit system. Can be unit system object, result_info object int or string.In case of int it is one of the predefined Ansys unit system ids, in case of string it should be a semicolon separated list of units. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| results |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Result in the json format. | +| **Pin 0**| results |[`string`](../../core-concepts/dpf-types.md#standard-types) | Result in the json format. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/minmax_per_element_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/minmax_per_element_operator.md index 1590fe17e0..bf2e28e15f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/minmax_per_element_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/minmax_per_element_operator.md @@ -31,7 +31,7 @@ Computes minmax Elemental data per element | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/multiple_failure_criteria_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/multiple_failure_criteria_operator.md index b548b91e01..bc29b3b86a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/multiple_failure_criteria_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/multiple_failure_criteria_operator.md @@ -20,11 +20,11 @@ Uses failure configuration, CMeshedRegion and stress and strain fields to comput | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | | | Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section data fields container. Only needed for some of the failure criteria evaluations. | | Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Mesh property fields container. Only needed if eLayupModelContextPin (218) is true. | -| Pin 100
Required| configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Combined failure criterion configuration (string of json dict | -| Pin 102
Required| check_meshed_region |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The check is enabled by default but it can be costly if the meshes are huge. | -| Pin 103
Required| is_acp_composite_model |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Deprecated since 2024 R2. Please use eLayupModelContextPin (pin 218). Set to true for ACP composites models. Default is false. | -| Pin 104
Required| skip_sandwich_criteria |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Skip the sandwich criteria. This should be true if not all plies are selected in which case sandwich criteria cannot be evaluated in a meaningful way. Default is false. | -| Pin 218
Required| layup_model_context_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Define the source of section data. Values are: 0=not available, 1=ACP, 2=RST, 3=MIXED (ACP+RST). Default is not available. | +| Pin 100
Required| configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Combined failure criterion configuration (string of json dict | +| Pin 102
Required| check_meshed_region |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The check is enabled by default but it can be costly if the meshes are huge. | +| Pin 103
Required| is_acp_composite_model |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Deprecated since 2024 R2. Please use eLayupModelContextPin (pin 218). Set to true for ACP composites models. Default is false. | +| Pin 104
Required| skip_sandwich_criteria |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Skip the sandwich criteria. This should be true if not all plies are selected in which case sandwich criteria cannot be evaluated in a meaningful way. Default is false. | +| Pin 218
Required| layup_model_context_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Define the source of section data. Values are: 0=not available, 1=ACP, 2=RST, 3=MIXED (ACP+RST). Default is not available. | | Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | CFieldsContainer with strains | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | CFieldsContainer with stresses | @@ -38,7 +38,7 @@ Uses failure configuration, CMeshedRegion and stress and strain fields to comput | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/nearest_neighbor_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/nearest_neighbor_operator.md index 9efa481e44..5fac2ea42c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/nearest_neighbor_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/nearest_neighbor_operator.md @@ -18,7 +18,7 @@ Go through all elements of the source mesh and find the n nearest neighbors in t |-------|-------|------------------|-------------| | Pin 0
Required| source_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed region with the elements for which the nearest neighbors should be found. | | Pin 1
Required| target_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh with the target elements. | -| Pin 2
Required| number_of_neighbors |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Number of neighbors to be found. | +| Pin 2
Required| number_of_neighbors |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of neighbors to be found. | ## Outputs @@ -31,7 +31,7 @@ Go through all elements of the source mesh and find the n nearest neighbors in t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/puck_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/puck_operator.md index c92bf651a5..3216f14e2b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/puck_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/puck_operator.md @@ -18,9 +18,9 @@ Computes Puck for ElementalNodal data |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification (json dict as string): For instance {"force_global_constants": false, "dim": 2, "p_21_pos": 0.325, "p_21_neg": 0.275, "p_22_neg": 0.225, "p_22_pos": 0.225, "interface_weakening_factor": 0.8, "s": 0.5, "M": 0.5, "pf": false, "pma": false, "pmb": false, "pmc": false, "pd": false, "wf_pf": 1., "wf_pma": 1., "wf_pmb": 1., "wf_pmc": 1., "wf_pd": 1., "cfps": true} | -| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, only computes failure criteria for ply type 'isotropic' | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance {"force_global_constants": false, "dim": 2, "p_21_pos": 0.325, "p_21_neg": 0.275, "p_22_neg": 0.225, "p_22_pos": 0.225, "interface_weakening_factor": 0.8, "s": 0.5, "M": 0.5, "pf": false, "pma": false, "pmb": false, "pmc": false, "pd": false, "wf_pf": 1., "wf_pma": 1., "wf_pmb": 1., "wf_pmc": 1., "wf_pd": 1., "cfps": true} | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | @@ -34,7 +34,7 @@ Computes Puck for ElementalNodal data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/reference_surface_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/reference_surface_operator.md index 6805982e7e..4733f8e842 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/reference_surface_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/reference_surface_operator.md @@ -17,7 +17,7 @@ Reads the reference surface from solid composite definition file(s) and generate | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | List of composite definitions (h5) files with mapping files. Use the sResultKey to name the parts. | -| Pin 310
Required| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}) | Unit system. The output (mesh) will be converted into this unit system. | +| Pin 310
Required| unit_system |class dataProcessing::unit::CUnitSystem, [`result_info`](../../core-concepts/dpf-types.md#result-info), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Unit system. The output (mesh) will be converted into this unit system. | ## Outputs @@ -30,7 +30,7 @@ Reads the reference surface from solid composite definition file(s) and generate | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/result_definition.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/result_definition.md index 744aecf1f4..d53aa690f6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/result_definition.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/result_definition.md @@ -16,19 +16,19 @@ Uses a simplified json config to create a result definition | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Simplified configuration (string of json dict) Currently limited to a single time step and a single file per type.Supports only irf evaluation. Example: {"files":{"rst_file": "example_path","material_file": "example_path","layup_file": "example_path","mapping_file": "example_path"},"ply_ids": ["example_ply_1", "example_ply_2"],"element_ids": [1,2,3,4],"write_data_for_full_element_scope": false,"failure_configuration": {}} | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Simplified configuration (string of json dict) Currently limited to a single time step and a single file per type.Supports only irf evaluation. Example: {"files":{"rst_file": "example_path","material_file": "example_path","layup_file": "example_path","mapping_file": "example_path"},"ply_ids": ["example_ply_1", "example_ply_2"],"element_ids": [1,2,3,4],"write_data_for_full_element_scope": false,"failure_configuration": {}} | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| string |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Result Definition (string of json dict) that can be used for the composite_failure_operator | +| **Pin 0**| string |[`string`](../../core-concepts/dpf-types.md#standard-types) | Result Definition (string of json dict) that can be used for the composite_failure_operator | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/run_mapdl_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/run_mapdl_operator.md index e20a189fff..bb66ef0676 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/run_mapdl_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/run_mapdl_operator.md @@ -16,10 +16,10 @@ Runs mapdl and returns CFieldsContainer with the results at requested time | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_scoping |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0
Required| time_scoping |[`double`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 1
Required| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources with the input rst file | -| Pin 107
Required| result_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Results to read from rst file. Comma separated string. Supports 'S' and 'EPEL'. Example: 'S,EPEL' | +| Pin 107
Required| result_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Results to read from rst file. Comma separated string. Supports 'S' and 'EPEL'. Example: 'S,EPEL' | ## Outputs @@ -31,7 +31,7 @@ Runs mapdl and returns CFieldsContainer with the results at requested time | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/scope_config_reader.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/scope_config_reader.md index 7373a00073..1cc004cbf0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/scope_config_reader.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/scope_config_reader.md @@ -16,7 +16,7 @@ Reads scope configuration from inputs and outputs a CompositeScopeConfig object. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 108| ply_ids |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Vector of selected plies. | +| Pin 108| ply_ids |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Vector of selected plies. | | Pin 307| scope_configuration |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | DataTree with scope configuration: These properties are available: requested_times: optional[double]. Default: Last time step/ load step selected. | ## Outputs @@ -29,7 +29,7 @@ Reads scope configuration from inputs and outputs a CompositeScopeConfig object. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/scope_generator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/scope_generator.md index ac6701d195..b6ad7b6c26 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/scope_generator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/scope_generator.md @@ -16,7 +16,7 @@ Generator operator that returns an element chunk each time generator_counteris m | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| generator_counter |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Increment this input to get the next element scope for output element_scoping . | +| Pin 0
Required| generator_counter |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Increment this input to get the next element scope for output element_scoping . | | Pin 1| element_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Element scoping | | Pin 3| stream_provider |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | stream_provider of the result file. Required if no explicit element scope is providedor the result definition contains Named Selections. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Composite data sources | @@ -27,13 +27,13 @@ Generator operator that returns an element chunk each time generator_counteris m | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| | **Pin 0**| element_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Element scoping for current chunk. | -| **Pin 1**| is_finished |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Returns true if generator has returned all the requested elements. In this case the output of pin element_scoping is empty. | +| **Pin 1**| is_finished |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Returns true if generator has returned all the requested elements. In this case the output of pin element_scoping is empty. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/shear_crimping_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/shear_crimping_operator.md index 0f86948d5d..325d9568f5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/shear_crimping_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/shear_crimping_operator.md @@ -20,8 +20,8 @@ Computes shear crimping criterion for layered elements. Use the composite::layup | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | | Pin 24
Required| section_data_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Section Data Container | | Pin 25
Required| mesh_properties_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Properties from the ACP model to compute Shear Crimping for solids. Not needed to compute wrinkling for shells. | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification (json dict as string): For instance "{"active": true, "kc" : 1., "kf" : 0., "wf" : 1.0}" | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "kc" : 1., "kf" : 0., "wf" : 1.0}" | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs @@ -34,7 +34,7 @@ Computes shear crimping criterion for layered elements. Use the composite::layup | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/short_fiber_failure_criterion_evaluator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/short_fiber_failure_criterion_evaluator.md index 9739c427d1..7dce11d6b7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/short_fiber_failure_criterion_evaluator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/short_fiber_failure_criterion_evaluator.md @@ -16,9 +16,9 @@ Evaluates failure criteria for short fiber composites. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Time Scoping | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Time Scoping | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Mesh Scoping | -| Pin 2| stress_limit_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to use 'ultimate' or 'yield' strengths. Default is 'ultimate'. | +| Pin 2| stress_limit_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Whether to use 'ultimate' or 'yield' strengths. Default is 'ultimate'. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional: RST File stream. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Input files: APDL ds.dat, APDL RST file, Engineering Data MatML file. | @@ -33,7 +33,7 @@ Evaluates failure criteria for short fiber composites. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/short_fiber_fatigue_equivalent_stress_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/short_fiber_fatigue_equivalent_stress_operator.md index bc77e86d26..ec7457f7ba 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/short_fiber_fatigue_equivalent_stress_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/short_fiber_fatigue_equivalent_stress_operator.md @@ -18,7 +18,7 @@ Computes Hill-type Equivalent Stress for ElementalNodal data |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 401
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs @@ -31,7 +31,7 @@ Computes Hill-type Equivalent Stress for ElementalNodal data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/short_fiber_lifetime_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/short_fiber_lifetime_operator.md index 38180243c0..1f4447e826 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/short_fiber_lifetime_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/short_fiber_lifetime_operator.md @@ -16,7 +16,7 @@ Lifetime evaluation for short fiber composites. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Time Scoping | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Time Scoping | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Mesh Scoping | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional: RST File stream. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Input files: APDL ds.dat, APDL RST file, Engineering Data MatML file. | @@ -32,7 +32,7 @@ Lifetime evaluation for short fiber composites. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/string_container.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/string_container.md index 5902d75d7c..1031dccff7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/string_container.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/string_container.md @@ -16,19 +16,19 @@ Operator which stores a string at each input pin. It supports unlimited number o | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| string |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | First value. | +| Pin 0| string |[`string`](../../core-concepts/dpf-types.md#standard-types) | First value. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| strings |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | List of input strings | +| **Pin 0**| strings |[`vector`](../../core-concepts/dpf-types.md#standard-types) | List of input strings | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/tsai_hill_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/tsai_hill_operator.md index f6ec57655e..6bd69d4d31 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/tsai_hill_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/tsai_hill_operator.md @@ -18,9 +18,9 @@ Computes Tsai-Hill for ElementalNodal data |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, only computes failure criteria for ply types 'woven' and 'regular' | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs @@ -33,7 +33,7 @@ Computes Tsai-Hill for ElementalNodal data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/tsai_wu_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/tsai_wu_operator.md index 422eb9701d..02e3885c4a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/tsai_wu_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/tsai_wu_operator.md @@ -18,9 +18,9 @@ Computes Tsai-Wu for ElementalNodal data |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Meshed Region | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, only computes failure criteria for ply types 'woven' and 'regular' | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "dim": 2, "wf": 1}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply types 'woven' and 'regular' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs @@ -33,7 +33,7 @@ Computes Tsai-Wu for ElementalNodal data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/unit_system_default.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/unit_system_default.md index cc023599df..84b5639f53 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/unit_system_default.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/unit_system_default.md @@ -29,7 +29,7 @@ Returns the in the rst stream if specified, otherwise return the default unit sy | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/composite/von_mises_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/composite/von_mises_operator.md index f7645427c7..3892702be8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/composite/von_mises_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/composite/von_mises_operator.md @@ -18,9 +18,9 @@ Computes VonMises for ElementalNodal data |-------|-------|------------------|-------------| | Pin 7
Required| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 23
Required| materials_container |[`materials_container`](../../core-concepts/dpf-types.md#materials-container) | Materials container | -| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Criterion specification (json dict as string): For instance "{"active": true, "vme" : true, "vms" : true, "wf_vme" : 1.0, "wf_vms" : 1.0}" | -| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, only computes failure criteria for ply type 'isotropic' | -| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 100
Required| criterion_configuration |[`string`](../../core-concepts/dpf-types.md#standard-types) | Criterion specification (json dict as string): For instance "{"active": true, "vme" : true, "vms" : true, "wf_vme" : 1.0, "wf_vms" : 1.0}" | +| Pin 101
Required| activate_ply_type_filter |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, only computes failure criteria for ply type 'isotropic' | +| Pin 102
Required| check_mesh_regions |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 400
Required| strains_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 401
Required| stresses_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | @@ -34,7 +34,7 @@ Computes VonMises for ElementalNodal data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/compression/apply_svd.md b/2025R2/dpf-framework-25-r2/operator-specifications/compression/apply_svd.md index 46c2ba043a..e480a8b074 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/compression/apply_svd.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/compression/apply_svd.md @@ -17,9 +17,9 @@ Computes the coefficients (=U*Sigma) and VT components from SVD. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field_contaner_to_compress |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields container to be compressed | -| Pin 1
Required| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | number of vectors (r) to keep for the future reconstraction of the matrix A, ex. A[m,n]=coef[m,r]*VT[r,n], where coef=U*Sigma | -| Pin 2
Required| scalar_double |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | threshold (precision) as a double, default value is 1e-7. If both pin1 and pin2 are provided, choose the min r-vectors | -| Pin 3
Required| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | apply svd on the initial data (Default : false), otherwise use reduced data (square matrix with the smallest dimensions). | +| Pin 1
Required| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types) | number of vectors (r) to keep for the future reconstraction of the matrix A, ex. A[m,n]=coef[m,r]*VT[r,n], where coef=U*Sigma | +| Pin 2
Required| scalar_double |[`double`](../../core-concepts/dpf-types.md#standard-types) | threshold (precision) as a double, default value is 1e-7. If both pin1 and pin2 are provided, choose the min r-vectors | +| Pin 3
Required| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | apply svd on the initial data (Default : false), otherwise use reduced data (square matrix with the smallest dimensions). | ## Outputs @@ -33,9 +33,9 @@ Computes the coefficients (=U*Sigma) and VT components from SVD. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/compression/apply_zfp.md b/2025R2/dpf-framework-25-r2/operator-specifications/compression/apply_zfp.md index 359ffe22f0..8de0f3349a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/compression/apply_zfp.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/compression/apply_zfp.md @@ -17,29 +17,29 @@ Compressing input data using one of zfp compression algorithm modes. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| dataIn |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container to be compressed | -| Pin 1
Required| mode |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`char`](../../core-concepts/dpf-types.md#char) | zfp mode: fixed-rate ('r'), fixed-precision ('p'), fixed-accuracy ('a') | -| Pin 2
Required| mode_parameter |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}) | mode-corresponding parameter: rate (double) / precision (int) / accuracy (double) | -| Pin 3| dim |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | dimension (1D/2D/3D) for data organization before the compression (int; default: 2) | -| Pin 4| order |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | xyz dimensions order, where x (row) corresponds to number of elementary data, y (col) - number of time steps, z - number of components (applicable only for 3d data) : 0=xyz, 1=yxz (int; default: 0) | -| Pin 5| double_absthreshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double positive small value. All the values smaller than max(small value, max(vi) * relative threshold) are considered as zero values, (default value: 1.0e-18). | -| Pin 6| double_relthreshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double relative threshold. Values smaller than (v1 - v2) < max(small value, v1 * relativeTol) are considered identical (default value: 1.0e-10). | +| Pin 1
Required| mode |[`string`](../../core-concepts/dpf-types.md#standard-types), [`char`](../../core-concepts/dpf-types.md#char) | zfp mode: fixed-rate ('r'), fixed-precision ('p'), fixed-accuracy ('a') | +| Pin 2
Required| mode_parameter |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | mode-corresponding parameter: rate (double) / precision (int) / accuracy (double) | +| Pin 3| dim |[`int32`](../../core-concepts/dpf-types.md#standard-types) | dimension (1D/2D/3D) for data organization before the compression (int; default: 2) | +| Pin 4| order |[`int32`](../../core-concepts/dpf-types.md#standard-types) | xyz dimensions order, where x (row) corresponds to number of elementary data, y (col) - number of time steps, z - number of components (applicable only for 3d data) : 0=xyz, 1=yxz (int; default: 0) | +| Pin 5| double_absthreshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. All the values smaller than max(small value, max(vi) * relative threshold) are considered as zero values, (default value: 1.0e-18). | +| Pin 6| double_relthreshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative threshold. Values smaller than (v1 - v2) < max(small value, v1 * relativeTol) are considered identical (default value: 1.0e-10). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| compress_speed |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | the output entity is a double, containing compression speed of the input data: for ElementalNodal location - [elements/sec], for Nodal location - [nodes/sec] | -| **Pin 1**| compress_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | the output entity is a double, containing compression rate = initial/compressed | +| **Pin 0**| compress_speed |[`double`](../../core-concepts/dpf-types.md#standard-types) | the output entity is a double, containing compression speed of the input data: for ElementalNodal location - [elements/sec], for Nodal location - [nodes/sec] | +| **Pin 1**| compress_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types) | the output entity is a double, containing compression rate = initial/compressed | | **Pin 2**| dataOut |[`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) | the output entity is a 'custom type field container'; each output field containing compressed results corresponding to one component data (ie. input vector field/fc contains 3 components will give 3 output fields), this is not the case when input pin3 is set to 3, all components will be compressed into one field. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cuda** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, zfp fixed-rate parallel (de)compression will use CUDA. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cuda** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, zfp fixed-rate parallel (de)compression will use CUDA. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/compression/kmeans_clustering.md b/2025R2/dpf-framework-25-r2/operator-specifications/compression/kmeans_clustering.md index 2be01110c0..44b28631ce 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/compression/kmeans_clustering.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/compression/kmeans_clustering.md @@ -16,10 +16,10 @@ Apply kMeans clustering to group data depending on the data's non-linearity. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| clusters_number |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | number of the clusters (dafault is 3) | -| Pin 1| formula |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | formula ('dist'/'dotprod'), default is 'dist' | +| Pin 0| clusters_number |[`int32`](../../core-concepts/dpf-types.md#standard-types) | number of the clusters (dafault is 3) | +| Pin 1| formula |[`string`](../../core-concepts/dpf-types.md#standard-types) | formula ('dist'/'dotprod'), default is 'dist' | | Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | an iunput fields container containing the data which will be used for the clustering | -| Pin 3| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | component number as an int (default is 0), ex '0' for X-displacement, '1' for Y-displacement,... | +| Pin 3| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types) | component number as an int (default is 0), ex '0' for X-displacement, '1' for Y-displacement,... | ## Outputs @@ -31,7 +31,7 @@ Apply kMeans clustering to group data depending on the data's non-linearity. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/compression/zfp_decompress.md b/2025R2/dpf-framework-25-r2/operator-specifications/compression/zfp_decompress.md index 79708bb7ab..9d022f872c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/compression/zfp_decompress.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/compression/zfp_decompress.md @@ -23,13 +23,13 @@ zfp decompression using the information about compression written into the prope | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| | **Pin 0**| dataOut |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | the output entity is a field or a fields container; it contains decompressed data | -| **Pin 1**| decompress_speed |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | the output entity is a double, containing decompression speed (mb/sec) | +| **Pin 1**| decompress_speed |[`double`](../../core-concepts/dpf-types.md#standard-types) | the output entity is a double, containing decompression speed (mb/sec) | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/abc_weightings.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/abc_weightings.md index 870e7eae87..76457bfcdf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/abc_weightings.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/abc_weightings.md @@ -17,8 +17,8 @@ Computes ABC-weightings for the amplitude spectrum in dB units. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | data to be weighted in dB units. | -| Pin 1
Required| weighting_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if this pin is set to 0, the A-weighting is computed, 1 the B-weigting is computed and 2 the C-weightings is computed. | -| Pin 2
Required| shape_by_tf_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if this pin is set to true, each field of the input fields container is defined by time freq scoping and not by ids. Default is false | +| Pin 1
Required| weighting_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | if this pin is set to 0, the A-weighting is computed, 1 the B-weigting is computed and 2 the C-weightings is computed. | +| Pin 2
Required| shape_by_tf_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if this pin is set to true, each field of the input fields container is defined by time freq scoping and not by ids. Default is false | ## Outputs @@ -30,8 +30,8 @@ Computes ABC-weightings for the amplitude spectrum in dB units. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_band_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_band_pass.md index e5f62b2c9b..330fd35499 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_band_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_band_pass.md @@ -17,8 +17,8 @@ The band pass filter returns all the values above (but not equal to) the minimum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | -| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | +| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | +| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | ## Outputs @@ -30,7 +30,7 @@ The band pass filter returns all the values above (but not equal to) the minimum | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_band_pass_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_band_pass_fc.md index e20c47988c..f8e1be0538 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_band_pass_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_band_pass_fc.md @@ -17,8 +17,8 @@ The band pass filter returns all the values above (but not equal to) the minimum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | -| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | +| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | +| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | ## Outputs @@ -30,7 +30,7 @@ The band pass filter returns all the values above (but not equal to) the minimum | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_high_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_high_pass.md index 8ccb6290d6..36dbc288ac 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_high_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_high_pass.md @@ -17,8 +17,8 @@ The high pass filter returns all the values above (but not equal to) the thresho | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -30,7 +30,7 @@ The high pass filter returns all the values above (but not equal to) the thresho | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_high_pass_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_high_pass_fc.md index cc0babc526..43672a89ab 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_high_pass_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_high_pass_fc.md @@ -17,8 +17,8 @@ The high pass filter returns all the values above (but not equal to) the thresho | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -30,7 +30,7 @@ The high pass filter returns all the values above (but not equal to) the thresho | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_low_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_low_pass.md index d7471ddcda..601eb09975 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_low_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_low_pass.md @@ -17,8 +17,8 @@ The low pass filter returns all the values below (but not equal to) the threshol | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -30,7 +30,7 @@ The low pass filter returns all the values below (but not equal to) the threshol | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_low_pass_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_low_pass_fc.md index 107600b4c8..227d497330 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_low_pass_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_low_pass_fc.md @@ -17,8 +17,8 @@ The low pass filter returns all the values below (but not equal to) the threshol | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -30,7 +30,7 @@ The low pass filter returns all the values below (but not equal to) the threshol | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_signed_high_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_signed_high_pass.md index 21224147ed..9e4e2b5644 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_signed_high_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_signed_high_pass.md @@ -17,8 +17,8 @@ The high pass filter returns all the values above, or equal, in absolute value t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -30,7 +30,7 @@ The high pass filter returns all the values above, or equal, in absolute value t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_signed_high_pass_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_signed_high_pass_fc.md index d230152d8a..a866e0f32d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_signed_high_pass_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/field_signed_high_pass_fc.md @@ -17,8 +17,8 @@ The high pass filter returns all the values above, or equal, in absolute value t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -30,7 +30,7 @@ The high pass filter returns all the values above, or equal, in absolute value t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/filtering_max_over_time.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/filtering_max_over_time.md index 380d2184b4..04a40a1163 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/filtering_max_over_time.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/filtering_max_over_time.md @@ -16,10 +16,10 @@ Creates a filtering workflow that will filter results based on a threshold of a | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| invariant_fc_operator |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Name of the invariant operator to be used to calculate filter (available: eqv_fc, invariants_deriv_fc, invariants_fc). | -| Pin 1| output_pin |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Output pin of the invariant operator. Default = 0. | -| Pin 2| list_of_results |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}) | If no result is given, filter will be applied on Stresses and Strains | -| Pin 3| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Threshold from which the operator will filter. | +| Pin 0
Required| invariant_fc_operator |[`string`](../../core-concepts/dpf-types.md#standard-types) | Name of the invariant operator to be used to calculate filter (available: eqv_fc, invariants_deriv_fc, invariants_fc). | +| Pin 1| output_pin |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Output pin of the invariant operator. Default = 0. | +| Pin 2| list_of_results |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | If no result is given, filter will be applied on Stresses and Strains | +| Pin 3| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | Threshold from which the operator will filter. | ## Outputs @@ -31,7 +31,7 @@ Creates a filtering workflow that will filter results based on a threshold of a | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_band_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_band_pass.md index 36bdccdd2a..9be64a06a0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_band_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_band_pass.md @@ -17,8 +17,8 @@ The band pass filter returns all the values above (but not equal to) the minimum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | -| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | +| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | +| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | ## Outputs @@ -30,7 +30,7 @@ The band pass filter returns all the values above (but not equal to) the minimum | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_high_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_high_pass.md index bfcb3a7b3e..77178ff20d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_high_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_high_pass.md @@ -17,8 +17,8 @@ The high pass filter returns all the values above (but not equal to) the thresho | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -30,7 +30,7 @@ The high pass filter returns all the values above (but not equal to) the thresho | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_low_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_low_pass.md index bee33f62d4..723ba65803 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_low_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_low_pass.md @@ -17,8 +17,8 @@ The low pass filter returns all the values below (but not equal to) the threshol | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -30,7 +30,7 @@ The low pass filter returns all the values below (but not equal to) the threshol | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_signed_high_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_signed_high_pass.md index c228005052..ec59fabbb5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_signed_high_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/scoping_signed_high_pass.md @@ -17,8 +17,8 @@ The high pass filter returns all the values above, or equal, in absolute value t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -30,7 +30,7 @@ The high pass filter returns all the values above, or equal, in absolute value t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_band_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_band_pass.md index 30f20ef4f7..303c2f0d00 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_band_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_band_pass.md @@ -17,8 +17,8 @@ The band pass filter returns all the values above (but not equal to) the minimum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | -| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | +| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | +| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | ## Outputs @@ -31,7 +31,7 @@ The band pass filter returns all the values above (but not equal to) the minimum | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_high_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_high_pass.md index ff571f7960..bba724621f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_high_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_high_pass.md @@ -17,8 +17,8 @@ The high pass filter returns all the values above (but not equal to) the thresho | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -31,7 +31,7 @@ The high pass filter returns all the values above (but not equal to) the thresho | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_low_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_low_pass.md index 3116e9a779..260311037c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_low_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_low_pass.md @@ -17,8 +17,8 @@ The low pass filter returns all the values below (but not equal to) the threshol | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -31,7 +31,7 @@ The low pass filter returns all the values below (but not equal to) the threshol | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_signed_high_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_signed_high_pass.md index 5abad211d2..6f59032385 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_signed_high_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timefreq_signed_high_pass.md @@ -17,8 +17,8 @@ The high pass filter returns all the values above, or equal, in absolute value t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -31,7 +31,7 @@ The high pass filter returns all the values above, or equal, in absolute value t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_band_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_band_pass.md index 7c2bab9752..7e80e0ef2b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_band_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_band_pass.md @@ -17,8 +17,8 @@ The band pass filter returns all the values above (but not equal to) the minimum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | -| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | +| Pin 1
Required| min_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A minimum threshold scalar or a field containing one value is expected. | +| Pin 2| max_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A maximum threshold scalar or a field containing one value is expected. | ## Outputs @@ -30,7 +30,7 @@ The band pass filter returns all the values above (but not equal to) the minimum | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_high_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_high_pass.md index 851651b822..3eb42c983a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_high_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_high_pass.md @@ -17,8 +17,8 @@ The high pass filter returns all the values above (but not equal to) the thresho | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -30,7 +30,7 @@ The high pass filter returns all the values above (but not equal to) the thresho | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_low_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_low_pass.md index e526d2cc7b..26a72910a8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_low_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_low_pass.md @@ -17,8 +17,8 @@ The low pass filter returns all the values below (but not equal to) the threshol | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | a threshold scalar or a field containing one value is expected | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -30,7 +30,7 @@ The low pass filter returns all the values below (but not equal to) the threshol | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_signed_high_pass.md b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_signed_high_pass.md index acc1f91762..aa28b7c9c9 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_signed_high_pass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/filter/timescoping_signed_high_pass.md @@ -17,8 +17,8 @@ The high pass filter returns all the values above, or equal, in absolute value t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | -| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | A threshold scalar or a field containing one value is expected. | +| Pin 2| both |[`bool`](../../core-concepts/dpf-types.md#standard-types) | The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. | ## Outputs @@ -30,7 +30,7 @@ The high pass filter returns all the values above, or equal, in absolute value t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/cartesian_to_spherical.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/cartesian_to_spherical.md index 876903e49c..ceb5e1cbc3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/cartesian_to_spherical.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/cartesian_to_spherical.md @@ -28,9 +28,9 @@ Converts 3D field from cartesian coordinates to spherical coordinates. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/cartesian_to_spherical_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/cartesian_to_spherical_fc.md index d8569fc403..77eabd852f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/cartesian_to_spherical_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/cartesian_to_spherical_fc.md @@ -28,9 +28,9 @@ Converts 3D field from cartesian coordinates to spherical coordinates. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/element_nodal_contribution.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/element_nodal_contribution.md index 6ffab19e8c..7d322be954 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/element_nodal_contribution.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/element_nodal_contribution.md @@ -18,7 +18,7 @@ Compute the fraction of the element measure attributed to each node of each elem |-------|-------|------------------|-------------| | Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Integrate the input field over a specific scoping. | -| Pin 2| volume_fraction |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, returns influence volume, area or length. If false, the values are normalized with the element volume, area or length. Default: true. | +| Pin 2| volume_fraction |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, returns influence volume, area or length. If false, the values are normalized with the element volume, area or length. Default: true. | ## Outputs @@ -30,7 +30,7 @@ Compute the fraction of the element measure attributed to each node of each elem | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/elements_facets_surfaces_over_time.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/elements_facets_surfaces_over_time.md index 34d6a61757..9ef615a07a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/elements_facets_surfaces_over_time.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/elements_facets_surfaces_over_time.md @@ -31,7 +31,7 @@ Calculates for a mesh, the surface of each element's facet over time for each sp | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/elements_volume.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/elements_volume.md index a624e1aad7..0aad719a68 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/elements_volume.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/elements_volume.md @@ -29,9 +29,9 @@ Compute the measure of the Elements (volume for 3D elements, surface for 2D elem | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/elements_volumes_over_time.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/elements_volumes_over_time.md index afd19c9f68..48c8397df6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/elements_volumes_over_time.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/elements_volumes_over_time.md @@ -30,7 +30,7 @@ Calculates for a mesh, the volume of each element over time for each specified t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/faces_area.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/faces_area.md index 7154135b9b..a845bbdab2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/faces_area.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/faces_area.md @@ -29,7 +29,7 @@ Compute the measure of the Faces (surface for 2D faces of a 3D model or length f | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/gauss_to_node.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/gauss_to_node.md index 11a4fec176..c9d4afef1e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/gauss_to_node.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/gauss_to_node.md @@ -30,7 +30,7 @@ Extrapolating results available at Gauss or quadrature points to nodal points fo | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/integrate_over_elements.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/integrate_over_elements.md index ed2b863439..47b68eec00 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/integrate_over_elements.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/integrate_over_elements.md @@ -30,9 +30,9 @@ Integration of an input field over mesh. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/normals.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/normals.md index 497a87126a..d16ccad721 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/normals.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/normals.md @@ -30,7 +30,7 @@ compute the normals at the given nodes or element scoping based on the given mes | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/normals_provider_nl.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/normals_provider_nl.md index 7d959fc66c..ec1ec309cb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/normals_provider_nl.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/normals_provider_nl.md @@ -18,7 +18,7 @@ Computes the normals on nodes/faces/elements based on integration points (more a |-------|-------|------------------|-------------| | Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Skin, face, or shell mesh region. | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Elemental, ElementalNodal, or Nodal scoping. Location derived from this. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | If no scoping, specifies location. If scoping is Elemental or ElementalNodal this overrides scoping. Default is Elemental. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | If no scoping, specifies location. If scoping is Elemental or ElementalNodal this overrides scoping. Default is Elemental. | ## Outputs @@ -30,7 +30,7 @@ Computes the normals on nodes/faces/elements based on integration points (more a | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate.md index 075d5254e1..39cb0f94be 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate.md @@ -29,9 +29,9 @@ Applies a transformation (rotation) matrix on a field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate_fc.md index d4c1c26be2..4fb58b98d4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate_fc.md @@ -29,9 +29,9 @@ Apply a transformation (rotation) matrix on all the fields of a fields container | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate_in_cylindrical_cs.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate_in_cylindrical_cs.md index c68542fb7c..70e472d49f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate_in_cylindrical_cs.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate_in_cylindrical_cs.md @@ -30,9 +30,9 @@ Rotates a field to its corresponding values into the specified cylindrical coord | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md index a73c6885eb..fbd87cf607 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md @@ -30,9 +30,9 @@ Rotates all the fields of a fields container (not defined with a cynlindrical co | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/spherical_to_cartesian.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/spherical_to_cartesian.md index 3b79fb87a9..f282ce40fb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/spherical_to_cartesian.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/spherical_to_cartesian.md @@ -28,9 +28,9 @@ Converts 3D field from spherical coordinates to cartesian coordinates. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/spherical_to_cartesian_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/spherical_to_cartesian_fc.md index cb314b27e2..ee4bee4b28 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/spherical_to_cartesian_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/spherical_to_cartesian_fc.md @@ -28,9 +28,9 @@ Converts 3D field from spherical coordinates to cartesian coordinates. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/geo/to_polar_coordinates.md b/2025R2/dpf-framework-25-r2/operator-specifications/geo/to_polar_coordinates.md index ccf2c58176..21a0308129 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/geo/to_polar_coordinates.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/geo/to_polar_coordinates.md @@ -29,9 +29,9 @@ Finds r, theta (rad), and z coordinates of a coordinates (nodal) field in a cart | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/convertnum_bcs_to_nod.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/convertnum_bcs_to_nod.md index 9a78c87e5c..4c786a8ee1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/convertnum_bcs_to_nod.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/convertnum_bcs_to_nod.md @@ -29,7 +29,7 @@ Converts a fields container from BCS to NOD ordering. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/convertnum_nod_to_bcs.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/convertnum_nod_to_bcs.md index 0c895f44e8..28c6b7e52f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/convertnum_nod_to_bcs.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/convertnum_nod_to_bcs.md @@ -29,7 +29,7 @@ Converts a fields container from NOD to BCS ordering. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/convertnum_op.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/convertnum_op.md index a6650301f7..4bc89b9816 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/convertnum_op.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/convertnum_op.md @@ -16,8 +16,8 @@ Converts a fields container from one mapdl ordering to another mapdl ordering. S | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_ordering |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Input ordering number | -| Pin 1
Required| output_ordering |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Output ordering number | +| Pin 0
Required| input_ordering |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Input ordering number | +| Pin 1
Required| output_ordering |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Output ordering number | | Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Expect fields container | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain the full file). | @@ -31,7 +31,7 @@ Converts a fields container from one mapdl ordering to another mapdl ordering. S | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_values.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_values.md index 9a05eb285d..4142276853 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_values.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_values.md @@ -28,9 +28,9 @@ Computes the element-wise Eigen values of a tensor field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_values_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_values_fc.md index 63ca3c8865..ab065583b1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_values_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_values_fc.md @@ -28,9 +28,9 @@ Computes the element-wise Eigen values of all the tensor fields of a fields cont | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_vectors.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_vectors.md index 2a2987c2ea..8242626e6c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_vectors.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_vectors.md @@ -28,7 +28,7 @@ Computes the element-wise Eigen vectors for each tensor in the field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_vectors_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_vectors_fc.md index c8b3ec2382..cb0dafe3cf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_vectors_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/eigen_vectors_fc.md @@ -28,9 +28,9 @@ Computes the element-wise Eigen vectors for each tensor in the fields of the fie | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/invariants.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/invariants.md index 1786249e1c..1631a80c59 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/invariants.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/invariants.md @@ -30,9 +30,9 @@ Computes the element-wise invariants of a tensor field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/invariants_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/invariants_fc.md index a5d3575b4d..1069ad173c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/invariants_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/invariants_fc.md @@ -30,9 +30,9 @@ Computes the element-wise invariants of all the tensor fields of a fields contai | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/principal_invariants.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/principal_invariants.md index bed21f8c5a..4ca9d61e6c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/principal_invariants.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/principal_invariants.md @@ -30,9 +30,9 @@ Computes the element-wise Eigen values of a tensor field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/principal_invariants_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/principal_invariants_fc.md index 1403bdcbb4..821d97029e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/principal_invariants_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/principal_invariants_fc.md @@ -30,9 +30,9 @@ Computes the element-wise Eigen values of all the tensor fields of a fields cont | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/segalman_von_mises_eqv.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/segalman_von_mises_eqv.md index 24ba17a006..6b2918bb48 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/segalman_von_mises_eqv.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/segalman_von_mises_eqv.md @@ -28,9 +28,9 @@ Computes the element-wise Segalman Von-Mises criteria on a tensor field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/segalman_von_mises_eqv_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/segalman_von_mises_eqv_fc.md index f4dcf2ecc9..0564edc293 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/segalman_von_mises_eqv_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/segalman_von_mises_eqv_fc.md @@ -28,9 +28,9 @@ Computes the element-wise Segalman Von-Mises criteria on all the tensor fields o | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/von_mises_eqv.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/von_mises_eqv.md index 7d1ad39844..299a196f6a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/von_mises_eqv.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/von_mises_eqv.md @@ -17,7 +17,7 @@ Computes the element-wise Von-Mises criteria on a tensor field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 13
Required| poisson_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Poisson ratio to be used in equivalent strain calculation. | +| Pin 13
Required| poisson_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Poisson ratio to be used in equivalent strain calculation. | ## Outputs @@ -29,9 +29,9 @@ Computes the element-wise Von-Mises criteria on a tensor field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/von_mises_eqv_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/von_mises_eqv_fc.md index 5ab5aa91e0..6832ed94c1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/invariant/von_mises_eqv_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/invariant/von_mises_eqv_fc.md @@ -17,7 +17,7 @@ Computes the element-wise Von-Mises criteria on all the tensor fields of a field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 13
Required| poisson_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Poisson ratio to be used in equivalent strain calculation. | +| Pin 13
Required| poisson_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Poisson ratio to be used in equivalent strain calculation. | ## Outputs @@ -29,9 +29,9 @@ Computes the element-wise Von-Mises criteria on all the tensor fields of a field | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/ascending_sort.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/ascending_sort.md index 9c45cb5306..440d20124d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/ascending_sort.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/ascending_sort.md @@ -17,8 +17,8 @@ Sort a field (in 0) in ascending order with an optional component priority table | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| component_priority_table |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | component priority table (vector of int) | -| Pin 2| sort_by_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, uses scoping to sort the field (default is false) | +| Pin 1| component_priority_table |[`vector`](../../core-concepts/dpf-types.md#standard-types) | component priority table (vector of int) | +| Pin 2| sort_by_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, uses scoping to sort the field (default is false) | ## Outputs @@ -30,7 +30,7 @@ Sort a field (in 0) in ascending order with an optional component priority table | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/ascending_sort_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/ascending_sort_fc.md index 421f210e3d..b9eaa2ba0d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/ascending_sort_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/ascending_sort_fc.md @@ -17,8 +17,8 @@ Sort a field (in 0) in ascending order with an optional component priority table | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| component_priority_table |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | component priority table (vector of int) | -| Pin 2| sort_by_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, uses scoping to sort the field (default is false) | +| Pin 1| component_priority_table |[`vector`](../../core-concepts/dpf-types.md#standard-types) | component priority table (vector of int) | +| Pin 2| sort_by_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, uses scoping to sort the field (default is false) | ## Outputs @@ -30,7 +30,7 @@ Sort a field (in 0) in ascending order with an optional component priority table | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_selector.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_selector.md index 6ede02bca4..17887c1232 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_selector.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_selector.md @@ -17,8 +17,8 @@ Creates a scalar/vector field based on the selected component. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | One or several component index that will be extracted from the initial field. | -| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Set a default value for components that do not exist. | +| Pin 1
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | One or several component index that will be extracted from the initial field. | +| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Set a default value for components that do not exist. | ## Outputs @@ -30,7 +30,7 @@ Creates a scalar/vector field based on the selected component. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_selector_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_selector_fc.md index f414fbd97b..f1b6124741 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_selector_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_selector_fc.md @@ -17,7 +17,7 @@ Creates a scalar fields container based on the selected component for each field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | one or several component index that will be extracted from the initial field. | +| Pin 1
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | one or several component index that will be extracted from the initial field. | ## Outputs @@ -29,7 +29,7 @@ Creates a scalar fields container based on the selected component for each field | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_transformer.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_transformer.md index a21e78af76..bec5aefc41 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_transformer.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_transformer.md @@ -17,8 +17,8 @@ Takes the input field and creates a field with overriden value on given componen | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | One or several component index that will be modified from the initial field. | -| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Set a default value for components selected. | +| Pin 1
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | One or several component index that will be modified from the initial field. | +| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Set a default value for components selected. | ## Outputs @@ -30,7 +30,7 @@ Takes the input field and creates a field with overriden value on given componen | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_transformer_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_transformer_fc.md index 636c1b8c2d..545811eafd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_transformer_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/component_transformer_fc.md @@ -17,8 +17,8 @@ Takes the input field and creates a field with overriden value on given componen | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | One or several component index that will be modified from the initial field. | -| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Set a default value for components selected. | +| Pin 1
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | One or several component index that will be modified from the initial field. | +| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Set a default value for components selected. | ## Outputs @@ -30,7 +30,7 @@ Takes the input field and creates a field with overriden value on given componen | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/descending_sort.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/descending_sort.md index 81a3dbdb96..e45251bdc4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/descending_sort.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/descending_sort.md @@ -17,8 +17,8 @@ Sort a field (in 0) in descending order, with an optional component priority tab | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| component_priority_table |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | component priority table (vector of int) | -| Pin 2| sort_by_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, uses scoping to sort the field (default is false) | +| Pin 1| component_priority_table |[`vector`](../../core-concepts/dpf-types.md#standard-types) | component priority table (vector of int) | +| Pin 2| sort_by_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, uses scoping to sort the field (default is false) | ## Outputs @@ -30,7 +30,7 @@ Sort a field (in 0) in descending order, with an optional component priority tab | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/descending_sort_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/descending_sort_fc.md index 4b27b04052..fe1d6778e7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/descending_sort_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/descending_sort_fc.md @@ -17,8 +17,8 @@ Sort a field (in 0) in descending order, with an optional component priority tab | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| component_priority_table |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | component priority table (vector of int) | -| Pin 2| sort_by_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, uses scoping to sort the field (default is false) | +| Pin 1| component_priority_table |[`vector`](../../core-concepts/dpf-types.md#standard-types) | component priority table (vector of int) | +| Pin 2| sort_by_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, uses scoping to sort the field (default is false) | ## Outputs @@ -30,7 +30,7 @@ Sort a field (in 0) in descending order, with an optional component priority tab | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/elementary_data_selector.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/elementary_data_selector.md index 90c446d3bc..2fe801d748 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/elementary_data_selector.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/elementary_data_selector.md @@ -17,9 +17,9 @@ Creates a scalar/vector field based on the selected elementary data. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| elementary_data_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | One or several elementary data index that will be extracted from the initial field. For field with nature matrix, this is the line indices to extract. | -| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Set a default value for elementary data that do not exist. | -| Pin 3| elementary_data_index_2 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | For field with nature matrix, this is the column indices to extract. | +| Pin 1
Required| elementary_data_index |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | One or several elementary data index that will be extracted from the initial field. For field with nature matrix, this is the line indices to extract. | +| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Set a default value for elementary data that do not exist. | +| Pin 3| elementary_data_index_2 |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | For field with nature matrix, this is the column indices to extract. | ## Outputs @@ -31,7 +31,7 @@ Creates a scalar/vector field based on the selected elementary data. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/elementary_data_selector_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/elementary_data_selector_fc.md index 7cb6c01384..90c87751f5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/elementary_data_selector_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/elementary_data_selector_fc.md @@ -17,8 +17,8 @@ Creates a scalar fields container based on the selected elementary data for each | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| elementary_data_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | one or several elementary data indices that will be extracted from the initial field. For a field with a nature matrix, this extracts the line indices. | -| Pin 3| elementary_data_index_2 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | For a field with nature matrix, this extracts the column indices. | +| Pin 1
Required| elementary_data_index |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | one or several elementary data indices that will be extracted from the initial field. For a field with a nature matrix, this extracts the line indices. | +| Pin 3| elementary_data_index_2 |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | For a field with nature matrix, this extracts the column indices. | ## Outputs @@ -30,7 +30,7 @@ Creates a scalar fields container based on the selected elementary data for each | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/enrich_materials.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/enrich_materials.md index 591ddf48be..3b09a78a0d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/enrich_materials.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/enrich_materials.md @@ -24,13 +24,13 @@ Takes a MaterialContainer and a stream and enriches the MaterialContainer using | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| MaterialContainer |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| MaterialContainer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_anys.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_anys.md index 3dea73fb06..5656099dc1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_anys.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_anys.md @@ -18,22 +18,22 @@ Takes two Any objects and compares them.Supported types: Field, FieldsContainer, |-------|-------|------------------|-------------| | Pin 0
Required| anyA |[`any`](../../core-concepts/dpf-types.md#any) | | | Pin 1
Required| anyB |[`any`](../../core-concepts/dpf-types.md#any) | | -| Pin 2
Required| double_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | -| Pin 3| double_tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. | -| Pin 4
Required| compare_auxiliary |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | For meshes and meshescontainer: compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | +| Pin 2
Required| double_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | +| Pin 3| double_tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. | +| Pin 4
Required| compare_auxiliary |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For meshes and meshescontainer: compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| included |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | bool (true if belongs...) | -| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| included |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if belongs...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_fc.md index 6ffa2dbef8..4d5b08750c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_fc.md @@ -18,21 +18,21 @@ Checks if two fields_container are identical. |-------|-------|------------------|-------------| | Pin 0
Required| fields_containerA |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 1
Required| fields_containerB |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 2| small_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double positive small value. Smallest value which will be considered during the comparison step. All the abs(values) in the field less than this value are considered as null, (default value:1.0e-14). | -| Pin 3| tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001). | +| Pin 2| small_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value which will be considered during the comparison step. All the abs(values) in the field less than this value are considered as null, (default value:1.0e-14). | +| Pin 3| tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | bool (true if identical...) | -| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_fields.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_fields.md index 685084e580..8b2fabd01b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_fields.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_fields.md @@ -18,21 +18,21 @@ Check if two fields are identical. |-------|-------|------------------|-------------| | Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 2| double_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | -| Pin 3| double_tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 < relativeTol. Default is 0.001. | +| Pin 2| double_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | +| Pin 3| double_tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 < relativeTol. Default is 0.001. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | bool (true if identical...) | -| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_generic_data_containers.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_generic_data_containers.md index cdaa4c7f65..b6af0f4dbd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_generic_data_containers.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_generic_data_containers.md @@ -18,22 +18,22 @@ Takes two generic data containers and compares them. Supported types: Field, Fie |-------|-------|------------------|-------------| | Pin 0
Required| generic_data_containerA |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | | | Pin 1
Required| generic_data_containerB |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | | -| Pin 2
Required| double_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | -| Pin 3| double_tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. | -| Pin 4
Required| compare_auxiliary |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | For meshes and meshescontainer: compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | +| Pin 2
Required| double_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | +| Pin 3| double_tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. | +| Pin 4
Required| compare_auxiliary |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For meshes and meshescontainer: compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| included |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | bool (true if belongs...) | -| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| included |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if belongs...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_mc.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_mc.md index a467f93c2c..313df8b5f5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_mc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_mc.md @@ -18,22 +18,22 @@ Checks if two meshes_container are identical. |-------|-------|------------------|-------------| | Pin 0
Required| meshes_containerA |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | | Pin 1
Required| meshes_containerB |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 2| small_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double positive small value. Smallest value which will be considered during the comparison step. All the abs(values) in the field less than this value are considered as null, (default value:1.0e-14). | -| Pin 3| tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001). | -| Pin 4
Required| compare_auxiliary |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | +| Pin 2| small_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value which will be considered during the comparison step. All the abs(values) in the field less than this value are considered as null, (default value:1.0e-14). | +| Pin 3| tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001). | +| Pin 4
Required| compare_auxiliary |[`bool`](../../core-concepts/dpf-types.md#standard-types) | compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | bool (true if identical...) | -| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_meshes.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_meshes.md index 786be1615e..38bab04b89 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_meshes.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_meshes.md @@ -18,21 +18,21 @@ Takes two meshes and compares them. Note: When comparing mesh properties, the cu |-------|-------|------------------|-------------| | Pin 0
Required| meshA |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 1
Required| meshB |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 2| small_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | define what is a small value for numeric comparison (default value:1.0e-14). | -| Pin 3| tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | define the relative tolerance ceil for numeric comparison (default is 0.001). | -| Pin 4
Required| compare_auxiliary |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | +| Pin 2| small_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | define what is a small value for numeric comparison (default value:1.0e-14). | +| Pin 3| tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | define the relative tolerance ceil for numeric comparison (default is 0.001). | +| Pin 4
Required| compare_auxiliary |[`bool`](../../core-concepts/dpf-types.md#standard-types) | compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| are_identical |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| are_identical |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_pfc.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_pfc.md index 38cfd5907d..134138303d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_pfc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_pfc.md @@ -23,14 +23,14 @@ Checks if two property_fields_container are identical. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | bool (true if identical...) | -| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_property_fields.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_property_fields.md index 393bdd0c96..dbeba135c8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_property_fields.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_property_fields.md @@ -23,14 +23,14 @@ Takes two property fields and compares them. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| are_identical |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 1**| information |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| are_identical |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 1**| information |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_sc.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_sc.md index c4d1aa0464..8cc79b9eee 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_sc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_sc.md @@ -23,14 +23,14 @@ Checks if two scopings_container are identical. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | bool (true if identical...) | -| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_scopings.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_scopings.md index 14057ccba7..32d099155d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_scopings.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_scopings.md @@ -23,14 +23,14 @@ Check if two scopings are identical. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | bool (true if identical...) | -| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if identical...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_string_fields.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_string_fields.md index fde0f96c0e..99e79e6d2f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_string_fields.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/identical_string_fields.md @@ -23,14 +23,14 @@ Takes two string fields and compares them. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| are_identical |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 1**| information |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| are_identical |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 1**| information |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/included_fields.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/included_fields.md index 3036d92890..7f8e2a92dc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/included_fields.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/included_fields.md @@ -18,21 +18,21 @@ Checks if one field belongs to another. |-------|-------|------------------|-------------| | Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 2
Required| double_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | -| Pin 3| double_tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. | +| Pin 2
Required| double_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14). | +| Pin 3| double_tolerance |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| included |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | bool (true if belongs...) | -| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| included |[`bool`](../../core-concepts/dpf-types.md#standard-types) | bool (true if belongs...) | +| **Pin 1**| message |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/merge_solid_shell_fields.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/merge_solid_shell_fields.md index b0e5a65d35..f955860535 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/merge_solid_shell_fields.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/merge_solid_shell_fields.md @@ -28,7 +28,7 @@ Merges shell and solid fields for each time step/frequency in the fields contain | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/split_data_sources.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/split_data_sources.md index 73f0fc9cc2..19e8ad2f5e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/split_data_sources.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/split_data_sources.md @@ -17,20 +17,20 @@ Splits a Data Sources into multiple coherent data sources, actual number of outp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources to split. | -| Pin 1
Required| output_count |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Number of desired outputs. | +| Pin 1
Required| output_count |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of desired outputs. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin -1**| output_count |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Actual number of outputs. | +| **Pin -1**| output_count |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Actual number of outputs. | | **Pin 0**| outputs |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data sources outputs. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/logic/split_streams.md b/2025R2/dpf-framework-25-r2/operator-specifications/logic/split_streams.md index 5c22c1f379..5d3cbfebe1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/logic/split_streams.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/logic/split_streams.md @@ -17,20 +17,20 @@ Splits a Streams into multiple coherent streams, actual number of outputs is alw | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Streams to split. | -| Pin 1
Required| output_count |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Number of desired outputs. | +| Pin 1
Required| output_count |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of desired outputs. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin -1**| output_count |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Actual number of outputs. | +| **Pin -1**| output_count |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Actual number of outputs. | | **Pin 0**| outputs |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Streams outputs. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/fft.md b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/fft.md index dff8107b6d..9ad20c9177 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/fft.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/fft.md @@ -17,11 +17,11 @@ Computes the Fast Fourier Transform on each component of input Field or each fie | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Field or Fields Container. | -| Pin 3| scale_forward_transform |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Scale for Forward Transform, default is 2/field_num_elementary_data. | -| Pin 4| inplace |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | True if inplace, default is false. | -| Pin 5| force_fft_points |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Explicitely define number of fft points to either rescope or perform zero padding. | -| Pin 6| cutoff_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Restrict output frequency up to this cutoff frequency | -| Pin 7| scale_right_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If set to true (default is false), 2/field_num_entities scaling will be applied, to have right amplitude values. | +| Pin 3| scale_forward_transform |[`double`](../../core-concepts/dpf-types.md#standard-types) | Scale for Forward Transform, default is 2/field_num_elementary_data. | +| Pin 4| inplace |[`bool`](../../core-concepts/dpf-types.md#standard-types) | True if inplace, default is false. | +| Pin 5| force_fft_points |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Explicitely define number of fft points to either rescope or perform zero padding. | +| Pin 6| cutoff_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | Restrict output frequency up to this cutoff frequency | +| Pin 7| scale_right_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If set to true (default is false), 2/field_num_entities scaling will be applied, to have right amplitude values. | ## Outputs @@ -33,7 +33,7 @@ Computes the Fast Fourier Transform on each component of input Field or each fie | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/find_reduced_coordinates.md b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/find_reduced_coordinates.md index ae9df37510..fc61d551f0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/find_reduced_coordinates.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/find_reduced_coordinates.md @@ -18,7 +18,7 @@ Finds the elements corresponding to the given coordinates in input and computes |-------|-------|------------------|-------------| | Pin 1
Required| coordinates |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | If the first field in input has no mesh in support, then the mesh in this pin is expected (default is false). If a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container. | -| Pin 200| use_quadratic_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If this pin is set to true, reduced coordinates are computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. | +| Pin 200| use_quadratic_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, reduced coordinates are computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. | ## Outputs @@ -31,7 +31,7 @@ Finds the elements corresponding to the given coordinates in input and computes | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/on_coordinates.md b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/on_coordinates.md index 1a4ecd9c29..d67924cc68 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/on_coordinates.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/on_coordinates.md @@ -18,10 +18,10 @@ Evaluates a result on specified coordinates (interpolates results inside element |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 1
Required| coordinates |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 2| create_support |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if this pin is set to true, then, a support associated to the fields consisting of points is created | -| Pin 3| mapping_on_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if this pin is set to true, then the mapping between the coordinates and the fields is created only on the first field scoping | +| Pin 2| create_support |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if this pin is set to true, then, a support associated to the fields consisting of points is created | +| Pin 3| mapping_on_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if this pin is set to true, then the mapping between the coordinates and the fields is created only on the first field scoping | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | if the first field in input has no mesh in support, then the mesh in this pin is expected (default is false), if a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container | -| Pin 200| use_quadratic_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If this pin is set to true, the element search for each coordinate is computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. | +| Pin 200| use_quadratic_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, the element search for each coordinate is computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. | ## Outputs @@ -33,7 +33,7 @@ Evaluates a result on specified coordinates (interpolates results inside element | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/on_reduced_coordinates.md b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/on_reduced_coordinates.md index 8f7b1ff7ca..d7a4575513 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/on_reduced_coordinates.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/on_reduced_coordinates.md @@ -20,7 +20,7 @@ Evaluates a result on specified reduced coordinates of given elements (interpola | Pin 1
Required| reduced_coordinates |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | coordinates in the reference elements to find (found with the operator "find_reduced_coordinates") | | Pin 2
Required| element_ids |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Ids of the elements where each set of reduced coordinates is found (found with the operator "find_reduced_coordinates") | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | if the first field in input has no mesh in support, then the mesh in this pin is expected (default is false), if a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container | -| Pin 200| use_quadratic_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If this pin is set to true, the interpolation is computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. To use only when results have mid side nodes values. | +| Pin 200| use_quadratic_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, the interpolation is computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. To use only when results have mid side nodes values. | ## Outputs @@ -32,7 +32,7 @@ Evaluates a result on specified reduced coordinates of given elements (interpola | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/prep_sampling_fft.md b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/prep_sampling_fft.md index 2c92cf2f10..0ff8f82572 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/prep_sampling_fft.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/prep_sampling_fft.md @@ -17,8 +17,8 @@ Prepare time sampling optimum for FFT computation and expected frequencies in ou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | Initial time domain TimeFreqSupport. | -| Pin 1| cutoff_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Cutoff Frequency. In this case, number of points is calculated computing (time_range * cutoff_freq * 2) and taking the next power of 2 (optimum for fft calculation). | -| Pin 2| number_sampling_point |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | For number of sampling point (calculation with cutoff_frequency is ignored). | +| Pin 1| cutoff_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | Cutoff Frequency. In this case, number of points is calculated computing (time_range * cutoff_freq * 2) and taking the next power of 2 (optimum for fft calculation). | +| Pin 2| number_sampling_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | For number of sampling point (calculation with cutoff_frequency is ignored). | ## Outputs @@ -31,7 +31,7 @@ Prepare time sampling optimum for FFT computation and expected frequencies in ou | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/prepare_mapping_workflow.md b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/prepare_mapping_workflow.md index ace1b2a6ef..76e02276dd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/prepare_mapping_workflow.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/prepare_mapping_workflow.md @@ -18,8 +18,8 @@ Generates a workflow that can map results from a support to another one. |-------|-------|------------------|-------------| | Pin 0
Required| input_support |[`field`](../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 1
Required| output_support |[`field`](../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 2
Required| filter_radius |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Radius size for the RBF filter | -| Pin 3| influence_box |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 2
Required| filter_radius |[`double`](../../core-concepts/dpf-types.md#standard-types) | Radius size for the RBF filter | +| Pin 3| influence_box |[`double`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -31,7 +31,7 @@ Generates a workflow that can map results from a support to another one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/scoping_on_coordinates.md b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/scoping_on_coordinates.md index 19f55ecee4..b196ed58aa 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/scoping_on_coordinates.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/scoping_on_coordinates.md @@ -29,7 +29,7 @@ Finds the Elemental scoping of a set of coordinates. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/solid_to_skin.md b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/solid_to_skin.md index 513a0db9b7..8be9caaabb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/solid_to_skin.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/solid_to_skin.md @@ -30,7 +30,7 @@ Maps a field defined on solid elements to a field defined on skin elements. Thre | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/solid_to_skin_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/solid_to_skin_fc.md index 13b2a339fd..f4cd255fdf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mapping/solid_to_skin_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mapping/solid_to_skin_fc.md @@ -30,7 +30,7 @@ Maps a field defined on solid elements to a field defined on skin elements. Thre | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/absolute_value_by_component.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/absolute_value_by_component.md index 42ef4c387b..fea36e7325 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/absolute_value_by_component.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/absolute_value_by_component.md @@ -16,7 +16,7 @@ Compute the absolute value of each data value of the input field, no norm perfor | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs @@ -28,7 +28,7 @@ Compute the absolute value of each data value of the input field, no norm perfor | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/absolute_value_by_component_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/absolute_value_by_component_fc.md index db12393a28..dd1a9a94a7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/absolute_value_by_component_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/absolute_value_by_component_fc.md @@ -28,7 +28,7 @@ Compute the absolute value of each data value of the input field, no norm perfor | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate.md index 12d9a18fd2..d8bc8de744 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate.md @@ -30,7 +30,7 @@ Sums all the elementary data of a field to produce one elementary data point. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_fc.md index ced19acba4..43ff015716 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_fc.md @@ -30,7 +30,7 @@ Sums all the elementary data of a field to produce one elementary data point. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_level_over_label_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_level_over_label_fc.md index 351c038663..a126812b06 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_level_over_label_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_level_over_label_fc.md @@ -17,7 +17,7 @@ Compute the component-wise sum over all the fields that have the same ID as the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| label |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Label of the fields container where it should operate. | +| Pin 1| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label of the fields container where it should operate. | ## Outputs @@ -29,8 +29,8 @@ Compute the component-wise sum over all the fields that have the same ID as the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_min_over_label_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_min_over_label_fc.md index 9de93e48f9..8159f2204b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_min_over_label_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_min_over_label_fc.md @@ -17,7 +17,7 @@ Compute the component-wise sum over all the fields that have the same ID as the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| label |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Label of the fields container where it should operate. | +| Pin 1| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label of the fields container where it should operate. | ## Outputs @@ -29,8 +29,8 @@ Compute the component-wise sum over all the fields that have the same ID as the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_over_label_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_over_label_fc.md index b84ea41338..8331e89d27 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_over_label_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulate_over_label_fc.md @@ -17,7 +17,7 @@ Compute the component-wise sum over all the fields that have the same ID as the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| label |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Label of the fields container where it should operate. | +| Pin 1| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label of the fields container where it should operate. | ## Outputs @@ -29,8 +29,8 @@ Compute the component-wise sum over all the fields that have the same ID as the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulation_per_scoping.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulation_per_scoping.md index c38c6c25a5..182ebd48bf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulation_per_scoping.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/accumulation_per_scoping.md @@ -32,7 +32,7 @@ This operator calculates the sum and the percentage of total sum of the input fi | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/add.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/add.md index f45543cca6..51b174cd69 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/add.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/add.md @@ -16,8 +16,8 @@ Computes the sum of two fields. If one field's scoping has 'overall' location, t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs @@ -29,14 +29,14 @@ Computes the sum of two fields. If one field's scoping has 'overall' location, t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/add_constant.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/add_constant.md index af28a825e3..5bcd7dceb3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/add_constant.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/add_constant.md @@ -17,7 +17,7 @@ Computes the sum of a field (in 0) and a scalar (in 1). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| weights |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | double or vector of double | +| Pin 1
Required| weights |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | double or vector of double | ## Outputs @@ -29,7 +29,7 @@ Computes the sum of a field (in 0) and a scalar (in 1). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/add_constant_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/add_constant_fc.md index ac5e6ef5ea..bef73ecead 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/add_constant_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/add_constant_fc.md @@ -17,7 +17,7 @@ Computes the sum of a field (in 0) and a scalar (in 1). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| weights |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | double or vector of double | +| Pin 1
Required| weights |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | double or vector of double | ## Outputs @@ -29,7 +29,7 @@ Computes the sum of a field (in 0) and a scalar (in 1). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/add_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/add_fc.md index 65e63fb1fc..ebb21d61b7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/add_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/add_fc.md @@ -16,7 +16,7 @@ Selects all fields with the same label space in the input fields container and a | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -28,13 +28,13 @@ Selects all fields with the same label space in the input fields container and a | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/amplitude.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/amplitude.md index fc37d877c3..354e2509ce 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/amplitude.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/amplitude.md @@ -29,7 +29,7 @@ Computes amplitude of a real and an imaginary field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/amplitude_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/amplitude_fc.md index 888958eb92..20c296d918 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/amplitude_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/amplitude_fc.md @@ -28,7 +28,7 @@ Computes the amplitude of a real and an imaginary field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/average_over_label_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/average_over_label_fc.md index 58572f5a9a..7c2d14a11a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/average_over_label_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/average_over_label_fc.md @@ -17,7 +17,7 @@ Compute the component-wise average over all the fields that have the same ID as | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| label |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Label of the fields container where it should operate. | +| Pin 1| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label of the fields container where it should operate. | ## Outputs @@ -29,8 +29,8 @@ Compute the component-wise average over all the fields that have the same ID as | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/centroid.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/centroid.md index 28924ed02d..8ddc4d4553 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/centroid.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/centroid.md @@ -18,7 +18,7 @@ Computes centroid of field1 and field2, using fieldOut = field1*(1.-fact)+field2 |-------|-------|------------------|-------------| | Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | | Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 2
Required| factor |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Scalar | +| Pin 2
Required| factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | Scalar | ## Outputs @@ -30,10 +30,10 @@ Computes centroid of field1 and field2, using fieldOut = field1*(1.-fact)+field2 | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/centroid_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/centroid_fc.md index 08d6ea1d18..f47f1553ab 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/centroid_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/centroid_fc.md @@ -17,8 +17,8 @@ Computes the centroid of all the matching fields of a fields container at a give | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| time_freq |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 2| step |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1
Required| time_freq |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| step |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 8| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | ## Outputs @@ -31,8 +31,8 @@ Computes the centroid of all the matching fields of a fields container at a give | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_divide.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_divide.md index bad89e41e1..7f6b148d6a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_divide.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_divide.md @@ -29,14 +29,14 @@ Computes component-wise fraction between two fields of same dimensionality. If o | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_divide_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_divide_fc.md index f6a07c3f70..94d75069ef 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_divide_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_divide_fc.md @@ -29,13 +29,13 @@ For every two fields with the same label space (from the two input fields contai | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_product.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_product.md index 8b4f3a95c8..5adaf3f850 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_product.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_product.md @@ -29,14 +29,14 @@ Computes component-wise product between two fields of same dimensionality. If on | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_product_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_product_fc.md index 0eb54ee08f..9299ef8dab 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_product_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/component_wise_product_fc.md @@ -29,14 +29,14 @@ Computes component-wise product between two fields of same dimensionality. If on | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/compute_residual_and_error.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/compute_residual_and_error.md index 58709c38e3..7074e4047f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/compute_residual_and_error.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/compute_residual_and_error.md @@ -21,9 +21,9 @@ Computes the Lp-norm of a field or a field container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field_or_fields_container1 |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container - compulsory | -| Pin 1| normalization_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | type of normalization applied to the residuals and norm calculation (optional, defaut: absolute):
0 for absolute,
1 for relative to the first entry at a given time step,
2 for normalized by the max at a given time step of the first entry or residuals depending on the reference field option,
3 for normalized by the max over all time steps of the first entry or residuals depending on the reference field option | -| Pin 2| norm_calculation_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | type for norm calculation (optional, default: L2) - It is normalized depending on Pin2 selection
1 for L1, ie sum(abs(xi)),
2 for L2, ie sqrt(sum((xi^2)) | -| Pin 3| field_reference |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Field reference for the normalization step, default: 0 for entry 1, 1 for residuals - optional | +| Pin 1| normalization_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | type of normalization applied to the residuals and norm calculation (optional, defaut: absolute):
0 for absolute,
1 for relative to the first entry at a given time step,
2 for normalized by the max at a given time step of the first entry or residuals depending on the reference field option,
3 for normalized by the max over all time steps of the first entry or residuals depending on the reference field option | +| Pin 2| norm_calculation_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | type for norm calculation (optional, default: L2) - It is normalized depending on Pin2 selection
1 for L1, ie sum(abs(xi)),
2 for L2, ie sqrt(sum((xi^2)) | +| Pin 3| field_reference |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Field reference for the normalization step, default: 0 for entry 1, 1 for residuals - optional | | Pin 4| field_or_fields_container2 |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container of same dimensionality as entry 1 - optional | ## Outputs @@ -39,8 +39,8 @@ Computes the Lp-norm of a field or a field container. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/conjugate.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/conjugate.md index 78e89b1b0c..874dc79171 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/conjugate.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/conjugate.md @@ -28,7 +28,7 @@ Computes element-wise conjugate of field containers containing complex fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/correlation.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/correlation.md index 8c7d9a4cec..6d95cfc424 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/correlation.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/correlation.md @@ -16,23 +16,23 @@ Takes two fields and a weighting and computes their correlation: aMb/(||aMa||.|| | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Field a. The reference field. | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Field a. The reference field. | | Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Field b. If a fields container is provided, correlation is computed for each field. | | Pin 2
Required| weights |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Field M, optional weighting for correlation computation. | -| Pin 3
Required| absoluteValue |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, correlation factor is ||aMb||/(||aMa||.||bMb||) | +| Pin 3
Required| absoluteValue |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, correlation factor is ||aMb||/(||aMa||.||bMb||) | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| | **Pin 0**| field |[`field`](../../core-concepts/dpf-types.md#field) | Correlation factor for each input field b. | -| **Pin 1**| index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If several b are provided, this output contains the index of the highest correlation factor. | +| **Pin 1**| index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If several b are provided, this output contains the index of the highest correlation factor. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/cos.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/cos.md index bc92dd981e..d1567d45da 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/cos.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/cos.md @@ -28,7 +28,7 @@ Computes element-wise cos(field[i]). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/cos_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/cos_fc.md index 217448d07f..9c86983b1c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/cos_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/cos_fc.md @@ -28,7 +28,7 @@ Computes element-wise cos(field[i]). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_derive.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_derive.md index 91b54b7d64..43c192aad6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_derive.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_derive.md @@ -28,10 +28,10 @@ Derives field containers containing complex fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_divide.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_divide.md index f2bfc6113e..32901badd7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_divide.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_divide.md @@ -29,7 +29,7 @@ Computes division between two field containers containing complex fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_dot.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_dot.md index 5252cbcec4..a6e030b9fb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_dot.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_dot.md @@ -29,13 +29,13 @@ Computes product between two field containers containing complex fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_multiply.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_multiply.md index b9eb25c185..8114664c44 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_multiply.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/cplx_multiply.md @@ -29,13 +29,13 @@ Computes multiplication between two field containers containing complex fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/cross_product.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/cross_product.md index 702f404a58..0107044545 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/cross_product.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/cross_product.md @@ -16,8 +16,8 @@ Computes the cross product of two vector fields. Fields can have the same locati | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs @@ -29,13 +29,13 @@ Computes the cross product of two vector fields. Fields can have the same locati | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/cross_product_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/cross_product_fc.md index 06a1d09a0e..7f126faa24 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/cross_product_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/cross_product_fc.md @@ -16,8 +16,8 @@ Computes the cross product of two vector fields. Fields can have the same locati | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_or_fields_container_A |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | -| Pin 1
Required| field_or_fields_container_B |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | +| Pin 0
Required| field_or_fields_container_A |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| field_or_fields_container_B |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs @@ -29,13 +29,13 @@ Computes the cross product of two vector fields. Fields can have the same locati | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/dot.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/dot.md index b066c35d08..d890786741 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/dot.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/dot.md @@ -29,14 +29,14 @@ DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element - wise dot pr | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/dot_tensor.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/dot_tensor.md index ec3a92f212..4d3df12d3b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/dot_tensor.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/dot_tensor.md @@ -29,13 +29,13 @@ DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element-wise dot prod | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/entity_extractor.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/entity_extractor.md index e13936938c..74310354f7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/entity_extractor.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/entity_extractor.md @@ -17,7 +17,7 @@ Extracts an entity from a field, based on its ID. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1
Required| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -29,7 +29,7 @@ Extracts an entity from a field, based on its ID. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/expansion_psd.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/expansion_psd.md index 449c2977d9..681afda80d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/expansion_psd.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/expansion_psd.md @@ -32,9 +32,9 @@ Computes the PSD response for one-sigma solution. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/exponential.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/exponential.md index ea5f3fe104..8638cb77ba 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/exponential.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/exponential.md @@ -16,7 +16,7 @@ Computes element-wise exp(field[i]). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs @@ -28,7 +28,7 @@ Computes element-wise exp(field[i]). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/exponential_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/exponential_fc.md index 337f1827ab..6906c10816 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/exponential_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/exponential_fc.md @@ -28,7 +28,7 @@ Computes element-wise exp(field[i]). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_approx.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_approx.md index a3e2a8735f..b3a3861d52 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_approx.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_approx.md @@ -17,14 +17,14 @@ Computes the fitting curve using FFT filtering and cubic fitting in space (node | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping) | A time scoping to rescope / split the fields container given as input. | +| Pin 0| time_scoping |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | A time scoping to rescope / split the fields container given as input. | | Pin 1| mesh_scoping |[`umap`](../../core-concepts/dpf-types.md#umap), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | A space (mesh entities) scoping (or scopings container) to rescope / split the fields container given as input. | | Pin 2
Required| entity_to_fit |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Data changing in time to be fitted. | -| Pin 3
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Component number as an integer, for example '0' for X-displacement, '1' for Y-displacement, and so on. | -| Pin 4
Required| first_derivative |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Calculate the first derivative (bool). The default is false. | -| Pin 5
Required| second_derivative |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Calculate the second derivative (bool). The default is false. | -| Pin 6
Required| fit_data |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Calculate the fitted values (bool). The default is false | -| Pin 7| cutoff_fr |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Cutoff frequency. | +| Pin 3
Required| component_number |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Component number as an integer, for example '0' for X-displacement, '1' for Y-displacement, and so on. | +| Pin 4
Required| first_derivative |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Calculate the first derivative (bool). The default is false. | +| Pin 5
Required| second_derivative |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Calculate the second derivative (bool). The default is false. | +| Pin 6
Required| fit_data |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Calculate the fitted values (bool). The default is false | +| Pin 7| cutoff_fr |[`double`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Cutoff frequency. | ## Outputs @@ -38,9 +38,9 @@ Computes the fitting curve using FFT filtering and cubic fitting in space (node | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_eval.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_eval.md index d72ee85a7c..1f64aefc6e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_eval.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_eval.md @@ -30,7 +30,7 @@ Evaluate the fast fourier transforms at a given set of fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_gradient_eval.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_gradient_eval.md index 9c8101db8a..ac97b26d26 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_gradient_eval.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_gradient_eval.md @@ -18,7 +18,7 @@ Evaluate min max based on the fast fourier transform at a given field, using gra |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 1| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | if specified only the results at these set ids are used | -| Pin 2| fs_ratio |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | default value = 20 | +| Pin 2| fs_ratio |[`int32`](../../core-concepts/dpf-types.md#standard-types) | default value = 20 | ## Outputs @@ -30,7 +30,7 @@ Evaluate min max based on the fast fourier transform at a given field, using gra | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_multi_harmonic_minmax.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_multi_harmonic_minmax.md index 2c31a886b7..fb23624ed4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_multi_harmonic_minmax.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/fft_multi_harmonic_minmax.md @@ -18,13 +18,13 @@ Evaluate min max fields on multi harmonic solution. min and max fields are calcu |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 1| rpm_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | rpm scoping, by default the fourier series sum is evaluated using all the rpms | -| Pin 2| fs_ratio |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | -| Pin 3| num_subdivisions |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | connect number subdivisions, used for uniform discretization | -| Pin 4| max_num_subdivisions |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | connect max number subdivisions, used to avoid huge number of sudivisions | -| Pin 5| num_cycles |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Number of cycle of the periodic signal (default is 2) | -| Pin 6| use_harmonic_zero |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | use harmonic zero for first rpm (default is false) | -| Pin 7| calculate_time_series |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | calculates time series output (output pin 2), setting it to false enhance performance if only min/max are required (default is true) | -| Pin 8| substeps_selector |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | substeps to evaluate (frequencies), by default the operator is evaluated using all the available steps | +| Pin 2| fs_ratio |[`int32`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 3| num_subdivisions |[`int32`](../../core-concepts/dpf-types.md#standard-types) | connect number subdivisions, used for uniform discretization | +| Pin 4| max_num_subdivisions |[`int32`](../../core-concepts/dpf-types.md#standard-types) | connect max number subdivisions, used to avoid huge number of sudivisions | +| Pin 5| num_cycles |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of cycle of the periodic signal (default is 2) | +| Pin 6| use_harmonic_zero |[`bool`](../../core-concepts/dpf-types.md#standard-types) | use harmonic zero for first rpm (default is false) | +| Pin 7| calculate_time_series |[`bool`](../../core-concepts/dpf-types.md#standard-types) | calculates time series output (output pin 2), setting it to false enhance performance if only min/max are required (default is true) | +| Pin 8| substeps_selector |[`vector`](../../core-concepts/dpf-types.md#standard-types) | substeps to evaluate (frequencies), by default the operator is evaluated using all the available steps | ## Outputs @@ -38,7 +38,7 @@ Evaluate min max fields on multi harmonic solution. min and max fields are calcu | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/generalized_inner_product.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/generalized_inner_product.md index 482c799a7e..f084880ca8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/generalized_inner_product.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/generalized_inner_product.md @@ -16,8 +16,8 @@ Computes a general notion of inner product between two fields of possibly differ | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs @@ -29,13 +29,13 @@ Computes a general notion of inner product between two fields of possibly differ | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/generalized_inner_product_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/generalized_inner_product_fc.md index d03b2c837c..87a7f839f1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/generalized_inner_product_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/generalized_inner_product_fc.md @@ -16,8 +16,8 @@ Computes a general notion of inner product between two fields of possibly differ | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_or_fields_container_A |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | -| Pin 1
Required| field_or_fields_container_B |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | +| Pin 0
Required| field_or_fields_container_A |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| field_or_fields_container_B |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs @@ -29,13 +29,13 @@ Computes a general notion of inner product between two fields of possibly differ | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/hdf5_topo_elemental_density.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/hdf5_topo_elemental_density.md index a92e65ae17..8e83084142 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/hdf5_topo_elemental_density.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/hdf5_topo_elemental_density.md @@ -20,7 +20,7 @@ Extract Elemental Topology Density result from topo solver output. Default behav | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | | Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | topo file stream. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | topo file data source. | -| Pin 200
Required| custom_ponderation_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | take custom ponderation_field from the topo file by name | +| Pin 200
Required| custom_ponderation_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | take custom ponderation_field from the topo file by name | ## Outputs @@ -32,7 +32,7 @@ Extract Elemental Topology Density result from topo solver output. Default behav | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/hdf5_topo_nodal_density.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/hdf5_topo_nodal_density.md index 5d999c41fa..9c692e0692 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/hdf5_topo_nodal_density.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/hdf5_topo_nodal_density.md @@ -20,7 +20,7 @@ Extract Nodal Topology Density result from topo solver output. Default behavior | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | | Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | topo file stream. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | topo file data source. | -| Pin 200
Required| custom_ponderation_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | take custom ponderation_field from the topo file by name | +| Pin 200
Required| custom_ponderation_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | take custom ponderation_field from the topo file by name | ## Outputs @@ -32,7 +32,7 @@ Extract Nodal Topology Density result from topo solver output. Default behavior | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/img_part.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/img_part.md index 0386c9d699..f67a0e74fe 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/img_part.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/img_part.md @@ -28,7 +28,7 @@ Extracts element-wise imaginary part of field containers containing complex fiel | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/invert.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/invert.md index 5f4d7989d6..82eb52bf33 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/invert.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/invert.md @@ -28,7 +28,7 @@ DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inve | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/invert_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/invert_fc.md index 246d053f9f..13c6d8863f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/invert_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/invert_fc.md @@ -28,7 +28,7 @@ DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inve | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/kronecker_prod.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/kronecker_prod.md index e2dfafefaf..70771700c4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/kronecker_prod.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/kronecker_prod.md @@ -29,9 +29,9 @@ Computes element-wise Kronecker product between two tensor fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/linear_combination.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/linear_combination.md index dbc471f085..1019820cbd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/linear_combination.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/linear_combination.md @@ -16,10 +16,10 @@ Computes aXY + bZ where a,b (in 0, in 3) are scalar and X,Y,Z (in 1,2,4) are com | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| a |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double | +| Pin 0
Required| a |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double | | Pin 1
Required| fields_containerA |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 2
Required| fields_containerB |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3
Required| b |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Double | +| Pin 3
Required| b |[`double`](../../core-concepts/dpf-types.md#standard-types) | Double | | Pin 4
Required| fields_containerC |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | ## Outputs @@ -32,7 +32,7 @@ Computes aXY + bZ where a,b (in 0, in 3) are scalar and X,Y,Z (in 1,2,4) are com | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/ln.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/ln.md index 541f1a14ad..8e1a3e7d64 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/ln.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/ln.md @@ -16,7 +16,7 @@ Computes element-wise ln(field[i]). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | +| Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs @@ -28,7 +28,7 @@ Computes element-wise ln(field[i]). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/ln_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/ln_fc.md index 4bd344be5b..fe26c2821e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/ln_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/ln_fc.md @@ -28,7 +28,7 @@ Computes element-wise ln(field[i]). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/mac.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/mac.md index 5ae43a7fae..8014e246a2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/mac.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/mac.md @@ -30,7 +30,7 @@ Computes MAC Matrix between two fields container, both for real and complex case | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/make_one_on_comp.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/make_one_on_comp.md index 8b720c62c8..25679f33f0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/make_one_on_comp.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/make_one_on_comp.md @@ -17,7 +17,7 @@ Takes the input field's scoping and creates a field full of zeros, except for th | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1
Required| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -29,7 +29,7 @@ Takes the input field's scoping and creates a field full of zeros, except for th | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/matrix_inverse.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/matrix_inverse.md index 8b47c2e05a..d2bdb75d5b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/matrix_inverse.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/matrix_inverse.md @@ -28,7 +28,7 @@ Computes the complex matrix inverse for each field in the given fields container | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/mechanical_min_max_over_time.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/mechanical_min_max_over_time.md index e766e8cd6a..25873ad1d6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/mechanical_min_max_over_time.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/mechanical_min_max_over_time.md @@ -17,7 +17,7 @@ Evaluates minimum/maximum over time/frequency. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 5
Required| int32 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Define min or max. | +| Pin 5
Required| int32 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Define min or max. | ## Outputs @@ -30,7 +30,7 @@ Evaluates minimum/maximum over time/frequency. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/minus.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/minus.md index 7004acf478..acb311eb7c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/minus.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/minus.md @@ -16,8 +16,8 @@ Computes the difference of two fields. If one field's scoping has an 'overall' l | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs @@ -29,14 +29,14 @@ Computes the difference of two fields. If one field's scoping has an 'overall' l | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/minus_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/minus_fc.md index ec7af8789a..80bb7f2dae 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/minus_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/minus_fc.md @@ -16,8 +16,8 @@ Computes the difference of two fields. If one field's scoping has an 'overall' l | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| field_or_fields_container_A |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | -| Pin 1
Required| field_or_fields_container_B |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | +| Pin 0
Required| field_or_fields_container_A |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| field_or_fields_container_B |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs @@ -29,14 +29,14 @@ Computes the difference of two fields. If one field's scoping has an 'overall' l | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/modal_damping_ratio.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/modal_damping_ratio.md index 79531baabc..b44e8ea814 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/modal_damping_ratio.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/modal_damping_ratio.md @@ -16,11 +16,11 @@ Computes damping ratio for each mode shape as X_i = const + ratio_i + m_coeffici | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| natural_freq |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | input vector expects natural frequencies. | -| Pin 1| const_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | constant modal damping ratio | -| Pin 2| ratio_by_modes |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | modal damping ratio for each mode shape | -| Pin 3
Required| m_coefficient |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | global mass matrix multiplier | -| Pin 4
Required| k_coefficient |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | global stiffness matrix multiplier | +| Pin 0
Required| natural_freq |[`vector`](../../core-concepts/dpf-types.md#standard-types) | input vector expects natural frequencies. | +| Pin 1| const_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types) | constant modal damping ratio | +| Pin 2| ratio_by_modes |[`vector`](../../core-concepts/dpf-types.md#standard-types) | modal damping ratio for each mode shape | +| Pin 3
Required| m_coefficient |[`double`](../../core-concepts/dpf-types.md#standard-types) | global mass matrix multiplier | +| Pin 4
Required| k_coefficient |[`double`](../../core-concepts/dpf-types.md#standard-types) | global stiffness matrix multiplier | ## Outputs @@ -32,7 +32,7 @@ Computes damping ratio for each mode shape as X_i = const + ratio_i + m_coeffici | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/modal_participation.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/modal_participation.md index c41e498276..72b1814f42 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/modal_participation.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/modal_participation.md @@ -32,7 +32,7 @@ Compute the modal participation factor for a given vector field V, defined as s | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/modal_superposition.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/modal_superposition.md index 7c65b8f2c2..1826c5b5a0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/modal_superposition.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/modal_superposition.md @@ -18,7 +18,7 @@ Computes the solution in the time/frequency space from a modal solution by multi |-------|-------|------------------|-------------| | Pin 0
Required| modal_basis |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | One field by mode with each field representing a mode shape on nodes or elements. | | Pin 1
Required| solution_in_modal_space |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | One field by time/frequency with each field having a ponderating coefficient for each mode of the modal_basis pin. | -| Pin 3| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Compute the result on a subset of the time frequency domain defined in the solution_in_modal_space fields container. | +| Pin 3| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Compute the result on a subset of the time frequency domain defined in the solution_in_modal_space fields container. | | Pin 4| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Compute the result on a subset of the space domain defined in the modal_basis fields container. | ## Outputs @@ -31,10 +31,10 @@ Computes the solution in the time/frequency space from a modal solution by multi | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/modulus.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/modulus.md index 0a0d77de2e..d7fab74d8f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/modulus.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/modulus.md @@ -28,7 +28,7 @@ Computes element-wise modulus of field containers containing complex fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/norm.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/norm.md index 64486e5e86..3af1eee060 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/norm.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/norm.md @@ -17,7 +17,7 @@ Computes the element-wise Lp norm of the field elementary data. Default Lp=L2 | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Lp normalisation type, p = 1, 2, ...n - Default Lp=L2 | +| Pin 1| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Lp normalisation type, p = 1, 2, ...n - Default Lp=L2 | ## Outputs @@ -29,7 +29,7 @@ Computes the element-wise Lp norm of the field elementary data. Default Lp=L2 | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/norm_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/norm_fc.md index e076d12f61..5381162e54 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/norm_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/norm_fc.md @@ -17,7 +17,7 @@ Computes the element-wise L2 norm of the field elementary data. This process is | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Lp normalisation type, p = 1, 2, ...n - Default Lp=2 | +| Pin 1| scalar_int |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Lp normalisation type, p = 1, 2, ...n - Default Lp=2 | ## Outputs @@ -29,9 +29,9 @@ Computes the element-wise L2 norm of the field elementary data. This process is | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/outer_product.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/outer_product.md index 003e6813ad..6d71050953 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/outer_product.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/outer_product.md @@ -16,8 +16,8 @@ Computes the outer product of two vector fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | -| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | +| Pin 0
Required| fieldA |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| fieldB |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs @@ -29,13 +29,13 @@ Computes the outer product of two vector fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/overall_dot.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/overall_dot.md index 36769e76f5..b49cb057a7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/overall_dot.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/overall_dot.md @@ -29,7 +29,7 @@ Computes a dot product between two fields (fields are seen like a single large v | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/phase.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/phase.md index c340d4376a..1b1eb066f5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/phase.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/phase.md @@ -29,7 +29,7 @@ Computes the phase (in rad) between a real and an imaginary field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/phase_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/phase_fc.md index 216af128b2..0be2d4074b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/phase_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/phase_fc.md @@ -28,7 +28,7 @@ Computes phase (in rad) between real and imaginary fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/polar_to_cplx.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/polar_to_cplx.md index 7ca62f3474..544df6810d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/polar_to_cplx.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/polar_to_cplx.md @@ -28,7 +28,7 @@ Converts a complex number from polar form to complex. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/pow.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/pow.md index 5a95cb5ff0..174352c535 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/pow.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/pow.md @@ -17,7 +17,7 @@ Computes element-wise field[i]^p. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| factor |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1
Required| factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -29,7 +29,7 @@ Computes element-wise field[i]^p. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/pow_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/pow_fc.md index 5b59a76afe..22b16c327a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/pow_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/pow_fc.md @@ -17,7 +17,7 @@ Computes element-wise field[i]^p. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| factor |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1
Required| factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -29,7 +29,7 @@ Computes element-wise field[i]^p. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/qr_solve.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/qr_solve.md index 80cbc5f2a6..a210c76e8c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/qr_solve.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/qr_solve.md @@ -29,7 +29,7 @@ Computes the solution using QR factorization. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/real_part.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/real_part.md index f3b750182d..928ce0a654 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/real_part.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/real_part.md @@ -28,7 +28,7 @@ Extracts element-wise real part of field containers containing complex fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/relative_error.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/relative_error.md index 4f4c83b592..52c9a59334 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/relative_error.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/relative_error.md @@ -16,8 +16,8 @@ Computes the relative error between a reference scalar field and another scalar | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| value |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | -| Pin 1
Required| reference |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | field or fields container with only one field is expected | +| Pin 0
Required| value |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | +| Pin 1
Required| reference |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | field or fields container with only one field is expected | ## Outputs @@ -31,13 +31,13 @@ Computes the relative error between a reference scalar field and another scalar | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/scale.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/scale.md index 132772aaa6..9f9866d6fc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/scale.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/scale.md @@ -17,9 +17,9 @@ Scales a field by a constant factor. This factor can be a scalar or a vector, wh | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1
Required| weights |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Double/Field/Vector of doubles. When scoped on overall, same value(s) applied on all the data, when scoped elsewhere, corresponding values will be multiplied due to the scoping | -| Pin 2| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Default is false. If set to true, output of scale is made dimensionless | -| Pin 3| algorithm |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Default is 0 use mkl. If set to 1, don't | +| Pin 1
Required| weights |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Double/Field/Vector of doubles. When scoped on overall, same value(s) applied on all the data, when scoped elsewhere, corresponding values will be multiplied due to the scoping | +| Pin 2| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If set to true, output of scale is made dimensionless | +| Pin 3| algorithm |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Default is 0 use mkl. If set to 1, don't | ## Outputs @@ -31,8 +31,8 @@ Scales a field by a constant factor. This factor can be a scalar or a vector, wh | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/scale_by_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/scale_by_field.md index 81d7ebc6de..ca1ff3a849 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/scale_by_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/scale_by_field.md @@ -29,13 +29,13 @@ DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/scale_by_field_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/scale_by_field_fc.md index 730181765d..f6f509c85c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/scale_by_field_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/scale_by_field_fc.md @@ -29,13 +29,13 @@ DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **binary_operation** |[`binary_operation_enum`](../../core-concepts/dpf-types.md#binary-operation-enum), [`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/scale_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/scale_fc.md index b333e3d535..186bc5bb58 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/scale_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/scale_fc.md @@ -17,9 +17,9 @@ Scales a fields container by a constant factor. This factor can be a scalar, a v | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields container to be scaled | -| Pin 1
Required| weights |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Double/Vector of doubles/Field/FieldsContainer. When scoped on overall, same value(s) applied on all the data, when scoped elsewhere, corresponding values will be multiplied due to the scoping | -| Pin 2| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Default is false. If set to true, output of scale is made dimensionless | -| Pin 3| algorithm |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Default is 0 use mkl. If set to 1, don't | +| Pin 1
Required| weights |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Double/Vector of doubles/Field/FieldsContainer. When scoped on overall, same value(s) applied on all the data, when scoped elsewhere, corresponding values will be multiplied due to the scoping | +| Pin 2| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If set to true, output of scale is made dimensionless | +| Pin 3| algorithm |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Default is 0 use mkl. If set to 1, don't | ## Outputs @@ -31,10 +31,10 @@ Scales a fields container by a constant factor. This factor can be a scalar, a v | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/sin.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/sin.md index 9a5c39b635..47575b627c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/sin.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/sin.md @@ -28,7 +28,7 @@ Computes element-wise sin(field[i]). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/sin_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/sin_fc.md index 723f3a1586..31e0e68ce7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/sin_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/sin_fc.md @@ -28,7 +28,7 @@ Computes element-wise sin(field[i]). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/sqr.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/sqr.md index 70f8f5ed2e..2984c24798 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/sqr.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/sqr.md @@ -28,10 +28,10 @@ Computes element-wise field[i]^2. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/sqr_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/sqr_fc.md index 7f2e1e83b8..ed4e83c318 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/sqr_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/sqr_fc.md @@ -28,10 +28,10 @@ Computes element-wise field[i]^2. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/sqrt.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/sqrt.md index 2c1d6d1adb..14bace2ce1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/sqrt.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/sqrt.md @@ -28,7 +28,7 @@ Computes element-wise sqrt(field1). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/sqrt_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/sqrt_fc.md index f0eceb57a0..ec5276ace7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/sqrt_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/sqrt_fc.md @@ -28,7 +28,7 @@ Computes element-wise sqrt(field1). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/svd.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/svd.md index bfb83a4cef..3a51732022 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/svd.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/svd.md @@ -30,7 +30,7 @@ Computes the matrix singular value decomposition (SVD) for each field in the giv | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/sweeping_phase.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/sweeping_phase.md index f6090d8f9b..673c88d470 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/sweeping_phase.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/sweeping_phase.md @@ -18,10 +18,10 @@ Shifts the phase of a real and an imaginary field (in 0 and 1) of a given angle |-------|-------|------------------|-------------| | Pin 0
Required| real_field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | | Pin 1
Required| imaginary_field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 2
Required| angle |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 3| unit_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | String Unit. Supported values: "deg" or "rad". Default: "rad". | -| Pin 4
Required| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 5
Required| imaginary_part_null |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If the imaginary part field is empty and this pin is true, then the imaginary part is supposed to be 0 (default is false). | +| Pin 2
Required| angle |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 3| unit_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | String Unit. Supported values: "deg" or "rad". Default: "rad". | +| Pin 4
Required| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 5
Required| imaginary_part_null |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If the imaginary part field is empty and this pin is true, then the imaginary part is supposed to be 0 (default is false). | ## Outputs @@ -33,7 +33,7 @@ Shifts the phase of a real and an imaginary field (in 0 and 1) of a given angle | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/sweeping_phase_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/sweeping_phase_fc.md index e2b68f1e27..0a7f2fa4ca 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/sweeping_phase_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/sweeping_phase_fc.md @@ -17,9 +17,9 @@ Shifts the phase of all the corresponding real and imaginary fields of a fields | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 2
Required| angle |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 3| unit_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | String Unit. Supported values: "deg" or "rad". Default: "rad". | -| Pin 4
Required| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 2
Required| angle |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 3| unit_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | String Unit. Supported values: "deg" or "rad". Default: "rad". | +| Pin 4
Required| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -31,7 +31,7 @@ Shifts the phase of all the corresponding real and imaginary fields of a fields | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/time_derivation.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/time_derivation.md index c74dad55bb..0352728766 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/time_derivation.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/time_derivation.md @@ -17,7 +17,7 @@ Derives a field of time varying quantities with respect to time | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | field | -| Pin 1| spline_fitting |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Uses spline fitting on the input field to compute smooth derivatives | +| Pin 1| spline_fitting |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Uses spline fitting on the input field to compute smooth derivatives | ## Outputs @@ -29,7 +29,7 @@ Derives a field of time varying quantities with respect to time | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/time_freq_interpolation.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/time_freq_interpolation.md index 164a71f521..63c6992525 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/time_freq_interpolation.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/time_freq_interpolation.md @@ -17,10 +17,10 @@ Interpolates between all the matching fields of a fields container at given time | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| time_freq_values |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | list of frequencies or times needed. To specify load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". | -| Pin 2| step |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if a Field is set as input, the step ids should be its scoping. | -| Pin 3| interpolation_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 is ramped, 2 is stepped, default is 1. | -| Pin 4| force_new_time_freq_support |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If set to true, the output fields container will always have a new time freq support rescoped to the output time_freq_values (default is false). If set to false, the time freq support is only recreated when time or frequency values are between existing ones. | +| Pin 1
Required| time_freq_values |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | list of frequencies or times needed. To specify load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". | +| Pin 2| step |[`int32`](../../core-concepts/dpf-types.md#standard-types) | if a Field is set as input, the step ids should be its scoping. | +| Pin 3| interpolation_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 is ramped, 2 is stepped, default is 1. | +| Pin 4| force_new_time_freq_support |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If set to true, the output fields container will always have a new time freq support rescoped to the output time_freq_values (default is false). If set to false, the time freq support is only recreated when time or frequency values are between existing ones. | | Pin 8| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | ## Outputs @@ -33,8 +33,8 @@ Interpolates between all the matching fields of a fields container at given time | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/time_integration.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/time_integration.md index b5183ad874..1a14964bbc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/time_integration.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/time_integration.md @@ -17,10 +17,10 @@ Integrates a field of time varying quantities over time | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | field | -| Pin 1| resample_output |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Resample the output | -| Pin 2| absolute_error |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Absolute error for the resampling | -| Pin 3| minimum_step_size |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Minimum time step size for the resamplig | -| Pin 4| integration_constant |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Constant to be added to the integrated field | +| Pin 1| resample_output |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Resample the output | +| Pin 2| absolute_error |[`double`](../../core-concepts/dpf-types.md#standard-types) | Absolute error for the resampling | +| Pin 3| minimum_step_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | Minimum time step size for the resamplig | +| Pin 4| integration_constant |[`double`](../../core-concepts/dpf-types.md#standard-types) | Constant to be added to the integrated field | ## Outputs @@ -32,7 +32,7 @@ Integrates a field of time varying quantities over time | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/unit_convert.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/unit_convert.md index dc43faf087..0467db76e3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/unit_convert.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/unit_convert.md @@ -17,7 +17,7 @@ Converts an input field/fields container or mesh of a given unit to another unit | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| entity_to_convert |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 1
Required| unit_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field) | unit as a string, ex 'm' for meter, 'Pa' for pascal,... Or ansys unit system's ID, or a field from which expected unit will be extracted. | +| Pin 1
Required| unit_name |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | unit as a string, ex 'm' for meter, 'Pa' for pascal,... Or ansys unit system's ID, or a field from which expected unit will be extracted. | ## Outputs @@ -29,8 +29,8 @@ Converts an input field/fields container or mesh of a given unit to another unit | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/unit_convert_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/unit_convert_fc.md index 3c8af315ac..a3cc385ed1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/unit_convert_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/unit_convert_fc.md @@ -17,7 +17,7 @@ Converts an input fields container of a given unit to another unit. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| unit_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | unit as a string, ex 'm' for meter, 'Pa' for pascal,... | +| Pin 1
Required| unit_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | unit as a string, ex 'm' for meter, 'Pa' for pascal,... | ## Outputs @@ -29,8 +29,8 @@ Converts an input fields container of a given unit to another unit. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_bartlett.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_bartlett.md index 58e515c912..3934a17761 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_bartlett.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_bartlett.md @@ -28,7 +28,7 @@ Apply bartlett windowing on a given FieldsContainer having time label or a Field | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_bartlett_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_bartlett_fc.md index 5dfc2cc239..429ad54288 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_bartlett_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_bartlett_fc.md @@ -28,7 +28,7 @@ Apply bartlett windowing on a given FieldsContainer having time label or a Field | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_blackman.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_blackman.md index 0729a181ed..affdcd1b86 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_blackman.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_blackman.md @@ -28,7 +28,7 @@ Apply blackman windowing on a given FieldsContainer having time label or a Field | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_blackman_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_blackman_fc.md index f9a1f2dfd3..a61863a0a2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_blackman_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_blackman_fc.md @@ -28,7 +28,7 @@ Apply blackman windowing on a given FieldsContainer having time label or a Field | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hamming.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hamming.md index 324b1e5e46..e80646b1ed 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hamming.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hamming.md @@ -28,7 +28,7 @@ Apply hamming windowing on a given FieldsContainer having time label or a Field | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hamming_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hamming_fc.md index 7b9dead176..03e7273bc5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hamming_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hamming_fc.md @@ -28,7 +28,7 @@ Apply hamming windowing on a given FieldsContainer having time label or a Field | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hanning.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hanning.md index 9934bde079..9f3214aa94 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hanning.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hanning.md @@ -28,7 +28,7 @@ Apply hanning windowing on a given FieldsContainer having time label or a Field | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hanning_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hanning_fc.md index e495a81a14..b58127369c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hanning_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_hanning_fc.md @@ -28,7 +28,7 @@ Apply hanning windowing on a given FieldsContainer having time label or a Field | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_triangular.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_triangular.md index ef5fb68274..427e7b2263 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_triangular.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_triangular.md @@ -28,7 +28,7 @@ Apply triangular windowing on a given FieldsContainer having time label or a Fie | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_triangular_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_triangular_fc.md index 496b335273..b23b291714 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_triangular_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_triangular_fc.md @@ -28,7 +28,7 @@ Apply triangular windowing on a given FieldsContainer having time label or a Fie | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_welch.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_welch.md index 668a1922fa..e6f33c5f5e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_welch.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_welch.md @@ -28,7 +28,7 @@ Apply welch windowing on a given FieldsContainer having time label or a Field lo | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_welch_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_welch_fc.md index 7d2f6abc7a..5c02f6f9e5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/math/window_welch_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/math/window_welch_fc.md @@ -28,7 +28,7 @@ Apply welch windowing on a given FieldsContainer having time label or a Field lo | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/acmo_mesh_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/acmo_mesh_provider.md index 2c056262f4..1cf864f0ac 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/acmo_mesh_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/acmo_mesh_provider.md @@ -17,7 +17,7 @@ Converts an Assembly Mesh into a DPF Meshes container | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| assembly_mesh |[`ans_dispatch_holder`](../../core-concepts/dpf-types.md#ans-dispatch-holder), [`struct IAnsDispatch`](../../core-concepts/dpf-types.md#struct-iansdispatch) | | -| Pin 1| unit |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1| unit |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -29,7 +29,7 @@ Converts an Assembly Mesh into a DPF Meshes container | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/beam_properties.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/beam_properties.md index a6d093a5dd..c348c31eb2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/beam_properties.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/beam_properties.md @@ -47,9 +47,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/change_cs.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/change_cs.md index 06809a5269..b90eac24cf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/change_cs.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/change_cs.md @@ -29,9 +29,9 @@ Applies a transformation (rotation and displacement) matrix on a mesh or meshes | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/combine_levelset.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/combine_levelset.md index fec0c12a23..5a46d0457a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/combine_levelset.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/combine_levelset.md @@ -29,7 +29,7 @@ Takes two level sets and computes their binary union. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/decimate_mesh.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/decimate_mesh.md index 997c86cb5e..2118d2971c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/decimate_mesh.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/decimate_mesh.md @@ -17,8 +17,8 @@ Decimate a meshed region | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh to decimate | -| Pin 1| preservation_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Target ratio of elements to preserve, the actual number of elements preserved might differ. Default value is 0.5. | -| Pin 2| aggressiveness |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Quality measure for the resulting decimated mesh. Lower aggresiveness will provide a higher quality mesh with the tradeoff of higher execution time. Value range is 0 to 150, default is 0. | +| Pin 1| preservation_ratio |[`double`](../../core-concepts/dpf-types.md#standard-types) | Target ratio of elements to preserve, the actual number of elements preserved might differ. Default value is 0.5. | +| Pin 2| aggressiveness |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Quality measure for the resulting decimated mesh. Lower aggresiveness will provide a higher quality mesh with the tradeoff of higher execution time. Value range is 0 to 150, default is 0. | ## Outputs @@ -30,7 +30,7 @@ Decimate a meshed region | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/exclude_levelset.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/exclude_levelset.md index 9516076edd..10a2556296 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/exclude_levelset.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/exclude_levelset.md @@ -29,7 +29,7 @@ Takes two level sets and excludes the second one from the first. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/external_layer.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/external_layer.md index ed775363f1..553f6a3e7a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/external_layer.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/external_layer.md @@ -30,7 +30,7 @@ Extracts the external layer (thick skin) of the mesh (3D elements) in a new mesh | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/from_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/from_field.md index 394c721631..4422923c0f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/from_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/from_field.md @@ -28,7 +28,7 @@ Returns the meshed region contained in the support of the mesh. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/from_scoping.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/from_scoping.md index 13cad0766d..1951497650 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/from_scoping.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/from_scoping.md @@ -17,8 +17,8 @@ Extracts a meshed region from another meshed region based on a scoping. Regardin | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 1
Required| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | if nodal/face scoping, then the scoping is transposed respecting the inclusive pin | -| Pin 2| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | -| Pin 3| nodes_only |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | returns mesh with nodes only (without any elements or property fields). Default is false. | +| Pin 2| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types) | if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | +| Pin 3| nodes_only |[`bool`](../../core-concepts/dpf-types.md#standard-types) | returns mesh with nodes only (without any elements or property fields). Default is false. | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs @@ -31,7 +31,7 @@ Extracts a meshed region from another meshed region based on a scoping. Regardin | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/from_scopings.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/from_scopings.md index f8b71bc1e5..e7e79021b0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/from_scopings.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/from_scopings.md @@ -17,8 +17,8 @@ Extracts multiple meshed region base on a scoping and saved in a MeshesContainer | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 1
Required| scopings_container |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | if nodal scoping, then the scoping is transposed respecting the inclusive pin | -| Pin 2| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | -| Pin 3| nodes_only |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | returns mesh with nodes only (without any elements). Default is false. | +| Pin 2| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types) | if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | +| Pin 3| nodes_only |[`bool`](../../core-concepts/dpf-types.md#standard-types) | returns mesh with nodes only (without any elements). Default is false. | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs @@ -31,7 +31,7 @@ Extracts multiple meshed region base on a scoping and saved in a MeshesContainer | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/iso_surfaces.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/iso_surfaces.md index e95d546aa2..07d482a6c7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/iso_surfaces.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/iso_surfaces.md @@ -17,10 +17,10 @@ Extract multiple iso-contours from mesh_cut operator and set it into a meshes co | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | Field containing the values for the iso-surface computation. The mesh can be retrieved from this field's support or through pin 2. | -| Pin 1| num_surfaces |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If provided, iso_values are linearly computed between the min and the max of the field of results. If not, iso_values must be provided by the user through pin 4 | +| Pin 1| num_surfaces |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If provided, iso_values are linearly computed between the min and the max of the field of results. If not, iso_values must be provided by the user through pin 4 | | Pin 2| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh to compute the iso-surface from. Used when not given through the support of the field in pin 0. | -| Pin 3
Required| slice_surfaces |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. | -| Pin 4| vector_iso_values |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | If provided, user defined iso_values to compute. If not provided, iso_values are linearly compute between the min and the max of the field of results. | +| Pin 3
Required| slice_surfaces |[`bool`](../../core-concepts/dpf-types.md#standard-types) | True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. | +| Pin 4| vector_iso_values |[`vector`](../../core-concepts/dpf-types.md#standard-types) | If provided, user defined iso_values to compute. If not provided, iso_values are linearly compute between the min and the max of the field of results. | ## Outputs @@ -33,7 +33,7 @@ Extract multiple iso-contours from mesh_cut operator and set it into a meshes co | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/make_plane_levelset.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/make_plane_levelset.md index 11e5d10fc6..5fc707684e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/make_plane_levelset.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/make_plane_levelset.md @@ -30,7 +30,7 @@ Computes the level set for a plane using coordinates. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/make_sphere_levelset.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/make_sphere_levelset.md index f2e53483e9..76a63b9846 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/make_sphere_levelset.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/make_sphere_levelset.md @@ -18,7 +18,7 @@ Computes the level set for a sphere using coordinates. |-------|-------|------------------|-------------| | Pin 0
Required| coordinates |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | | | Pin 1
Required| origin |[`field`](../../core-concepts/dpf-types.md#field) | An overall 3d vector that gives a point of the plane. | -| Pin 2
Required| radius |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Sphere radius. | +| Pin 2
Required| radius |[`double`](../../core-concepts/dpf-types.md#standard-types) | Sphere radius. | ## Outputs @@ -30,7 +30,7 @@ Computes the level set for a sphere using coordinates. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_clip.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_clip.md index cc5dc766b3..b59e4cfa35 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_clip.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_clip.md @@ -17,10 +17,10 @@ Clips a volume mesh along an iso value x, and construct the volume mesh defined | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| iso_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | iso value | -| Pin 2
Required| closed_surface |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1: closed surface, 0: iso surface. | +| Pin 1
Required| iso_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | iso value | +| Pin 2
Required| closed_surface |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 1: closed surface, 0: iso surface. | | Pin 3| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 4
Required| slice_surfaces |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. | +| Pin 4
Required| slice_surfaces |[`bool`](../../core-concepts/dpf-types.md#standard-types) | True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. | ## Outputs @@ -33,7 +33,7 @@ Clips a volume mesh along an iso value x, and construct the volume mesh defined | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_cut.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_cut.md index f92ac2f905..1a9444234e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_cut.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_cut.md @@ -17,10 +17,10 @@ Extracts a skin of the mesh in triangles in a new meshed region. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | Field containing the values for the iso-surface computation. The mesh can be retrieved from this field's support or through pin 2. | -| Pin 1
Required| iso_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | iso value | -| Pin 2
Required| closed_surface |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1: closed surface, 0: iso surface. | +| Pin 1
Required| iso_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | iso value | +| Pin 2
Required| closed_surface |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 1: closed surface, 0: iso surface. | | Pin 3| mesh |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh to compute the iso-surface from. Used when not given through the support of the field in pin 0. | -| Pin 4
Required| slice_surfaces |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. | +| Pin 4
Required| slice_surfaces |[`bool`](../../core-concepts/dpf-types.md#standard-types) | True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. | ## Outputs @@ -32,7 +32,7 @@ Extracts a skin of the mesh in triangles in a new meshed region. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_extraction.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_extraction.md index d43f8c6163..36db74b66a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_extraction.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_extraction.md @@ -18,7 +18,7 @@ Take a mesh and a scoping (elemental or nodal) and create a new mesh that contai |-------|-------|------------------|-------------| | Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 1
Required| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 2| extension |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Number of extension layer | +| Pin 2| extension |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of extension layer | ## Outputs @@ -30,7 +30,7 @@ Take a mesh and a scoping (elemental or nodal) and create a new mesh that contai | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_get_attribute.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_get_attribute.md index f5751844e0..dac0c3a55f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_get_attribute.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_get_attribute.md @@ -17,20 +17,20 @@ Uses the MeshedRegion APIs to return a given attribute of the mesh in input. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Supported property names are: "connectivity", "reverse_connectivity", "mat", "faces_nodes_connectivity", "elements_faces_connectivity" (or any mesh's property field), "coordinates", "named_selection", "num_named_selections", "named_selection_names", "named_selection_locations", "node_scoping", "element_scoping", "face_scoping"... | -| Pin 2| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}) | Can be used to get a property at a given index, example: a named selection's number or by name, example: a named selection's name. | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "connectivity", "reverse_connectivity", "mat", "faces_nodes_connectivity", "elements_faces_connectivity" (or any mesh's property field), "coordinates", "named_selection", "num_named_selections", "named_selection_names", "named_selection_locations", "node_scoping", "element_scoping", "face_scoping"... | +| Pin 2| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Can be used to get a property at a given index, example: a named selection's number or by name, example: a named selection's name. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`field`](../../core-concepts/dpf-types.md#field), [`property_field`](../../core-concepts/dpf-types.md#property-field), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string_field`](../../core-concepts/dpf-types.md#string-field) | Returns a property field for properties: "connectivity", "reverse_connectivity", "mat", "faces_nodes_connectivity", "elements_faces_connectivity" (or any mesh's property field), a field for property: "coordinates", a scoping for properties:"named_selection", "node_scoping", "element_scoping", "face_scoping", a string field for properties: "named_selection_names", "named_selection_locations" and an int for property: "num_named_selections". | +| **Pin 0**| property |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`field`](../../core-concepts/dpf-types.md#field), [`property_field`](../../core-concepts/dpf-types.md#property-field), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string_field`](../../core-concepts/dpf-types.md#string-field) | Returns a property field for properties: "connectivity", "reverse_connectivity", "mat", "faces_nodes_connectivity", "elements_faces_connectivity" (or any mesh's property field), a field for property: "coordinates", a scoping for properties:"named_selection", "node_scoping", "element_scoping", "face_scoping", a string field for properties: "named_selection_names", "named_selection_locations" and an int for property: "num_named_selections". | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_plan_clip.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_plan_clip.md index 19a20adb43..c88a0f84bc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_plan_clip.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_plan_clip.md @@ -31,7 +31,7 @@ Clips a volume mesh along a plane and keeps one side. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_provider.md index d029b4e93c..fb0ff49e2f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_provider.md @@ -25,11 +25,11 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Optional time/frequency set ID of the mesh, supported for adaptative meshes. | +| Pin 0| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Optional time/frequency set ID of the mesh, supported for adaptative meshes. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1). | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids with one entity (vector) or region scoping with one id (scoping) (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | If 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids with one entity (vector) or region scoping with one id (scoping) (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 200| laziness |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | configurate whether lazy evaluation can be performed and to what extent. Supported attributes are:
- "num_named_selections"->num named selection to read (-1 is all, int32, default si -1), careful: the other named selections will not be available, use mesh_property_provider Operator to read them.
- all mesh property fields "mat", "named_selection", "apdl_element_type", "section"-> if set to 1 these properties will not be read and a workflow will be bounded to the properties to be evaluated on demand, with 0 they are read (default is 0).
- "all_available_properties" option set to 0 will return all possible properties | ## Outputs @@ -42,10 +42,10 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_graphics.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_graphics.md index d546df3db6..c151688bb1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_graphics.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_graphics.md @@ -17,7 +17,7 @@ Generate tessellation for input mesh | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 2| node_normals |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | average element normals for node normals (default no, use element normals for node normals) | +| Pin 2| node_normals |[`bool`](../../core-concepts/dpf-types.md#standard-types) | average element normals for node normals (default no, use element normals for node normals) | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs @@ -32,7 +32,7 @@ Generate tessellation for input mesh | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_graphics_edges.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_graphics_edges.md index 7d1a7c0c78..3bea963ec2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_graphics_edges.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_graphics_edges.md @@ -17,7 +17,7 @@ Generate edges of surface elements for input mesh | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 6| include_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 6| include_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs @@ -31,7 +31,7 @@ Generate edges of surface elements for input mesh | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_pyvista.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_pyvista.md index fbfb31005f..6016fa5574 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_pyvista.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_pyvista.md @@ -17,25 +17,25 @@ Export a MeshedRegion in the pyVista format. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 2| coordinates |[`field`](../../core-concepts/dpf-types.md#field) | Node coordinates. If not set, the node coordinates of the mesh are employed. | -| Pin 6| as_linear |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Export a linear version of the mesh (quadratic surface elements do no include midside nodes). If not set, defaults to true. | +| Pin 6| as_linear |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Export a linear version of the mesh (quadratic surface elements do no include midside nodes). If not set, defaults to true. | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | mesh to export in pyVista format | -| Pin 60| vtk_updated |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | True if the VTK version employed by pyVista is > VTK 9. Default true. | -| Pin 200| as_poly |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Export elements as polyhedrons (cell-face-node representation). Default false. | +| Pin 60| vtk_updated |[`bool`](../../core-concepts/dpf-types.md#standard-types) | True if the VTK version employed by pyVista is > VTK 9. Default true. | +| Pin 200| as_poly |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Export elements as polyhedrons (cell-face-node representation). Default false. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| | **Pin 0**| nodes |[`field`](../../core-concepts/dpf-types.md#field) | Node coordinates double vector | -| **Pin 1**| cells |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Cell connectivity int vector | -| **Pin 2**| cell_types |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Cell types property int vector | -| **Pin 3**| offsets |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | If vtk_updated=false, offsets int vector | +| **Pin 1**| cells |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Cell connectivity int vector | +| **Pin 2**| cell_types |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Cell types property int vector | +| **Pin 3**| offsets |[`vector`](../../core-concepts/dpf-types.md#standard-types) | If vtk_updated=false, offsets int vector | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_tetra.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_tetra.md index 21bf5a5705..2b4719da03 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_tetra.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/mesh_to_tetra.md @@ -30,7 +30,7 @@ Converts 3D meshes of arbitrary 3D element types into a tetrahedral mesh, output | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/meshes_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/meshes_provider.md index eb31bf8a2a..1bc584f904 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/meshes_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/meshes_provider.md @@ -25,11 +25,11 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Time/frequency set IDs required in output. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Time/frequency set IDs required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1). | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | ## Outputs @@ -41,10 +41,10 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/node_coordinates.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/node_coordinates.md index 2f3ec7e781..77c343fad9 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/node_coordinates.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/node_coordinates.md @@ -28,7 +28,7 @@ Returns the node coordinates of the mesh(es) in input. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/points_from_coordinates.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/points_from_coordinates.md index 5252f7edb9..c5650d3e88 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/points_from_coordinates.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/points_from_coordinates.md @@ -29,7 +29,7 @@ Extract a mesh made of points elements. This mesh is made from input meshes coor | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/skin.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/skin.md index 41fc4cf812..d387f33bb1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/skin.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/skin.md @@ -18,8 +18,8 @@ Extracts a skin of the mesh in a new meshed region. The material ID of initial e |-------|-------|------------------|-------------| | Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Nodal scoping to restrict the skin extraction to a set of nodes. If provided, a skin element is added to the skin mesh if all its nodes are in the scoping. | -| Pin 2| duplicate_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If input mesh contains shell elements, output mesh shell elements (boolean = 1) are duplicated, one per each orientation, or (boolean = 0) remain unchanged. | -| Pin 3| add_beam_point |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If input mesh contains beam or point elements, output mesh beam point elements (boolean = 1) are added or (boolean = 0) are ignored. Default: False | +| Pin 2| duplicate_shell |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If input mesh contains shell elements, output mesh shell elements (boolean = 1) are duplicated, one per each orientation, or (boolean = 0) remain unchanged. | +| Pin 3| add_beam_point |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If input mesh contains beam or point elements, output mesh beam point elements (boolean = 1) are added or (boolean = 0) are ignored. Default: False | ## Outputs @@ -35,7 +35,7 @@ Extracts a skin of the mesh in a new meshed region. The material ID of initial e | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/split_fields.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/split_fields.md index 389a2a38df..dfe3881717 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/split_fields.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/split_fields.md @@ -29,7 +29,7 @@ Split the input field or fields container based on the input mesh regions | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/split_mesh.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/split_mesh.md index aa4fa60a5e..e0d74ded6b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/split_mesh.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/split_mesh.md @@ -18,7 +18,7 @@ Split the input mesh into several meshes based on a given property (material pro |-------|-------|------------------|-------------| | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Scoping | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 13
Required| property |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 13
Required| property |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -30,7 +30,7 @@ Split the input mesh into several meshes based on a given property (material pro | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/stl_export.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/stl_export.md index 6c46439720..966c212ea6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/stl_export.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/stl_export.md @@ -17,7 +17,7 @@ export a mesh into a stl file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -29,7 +29,7 @@ export a mesh into a stl file. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/tri_mesh_skin.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/tri_mesh_skin.md index bc2c0c8b3a..f46345d3f2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/tri_mesh_skin.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/tri_mesh_skin.md @@ -17,7 +17,7 @@ Extracts a skin of the mesh in triangles in a new meshed region. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1| include_surfaces |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | True: meshing will also take into account shell and skin elements. False: meshing will ignore shell and skin elements. The default is false. | +| Pin 1| include_surfaces |[`bool`](../../core-concepts/dpf-types.md#standard-types) | True: meshing will also take into account shell and skin elements. False: meshing will ignore shell and skin elements. The default is false. | | Pin 2| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Nodal scoping to restrict the skin extraction to a set of nodes. If provided, a skin element is added to the skin mesh if all its nodes are in the scoping. | ## Outputs @@ -31,7 +31,7 @@ Extracts a skin of the mesh in triangles in a new meshed region. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/wireframe.md b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/wireframe.md index e9b8678c2a..2e0c114a4c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/mesh/wireframe.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/mesh/wireframe.md @@ -17,7 +17,7 @@ Take a mesh and extracts its sharp edges, using pin 1 value as a threshold angle | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle threshold in radian that will trigger an edge detection. | +| Pin 1
Required| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle threshold in radian that will trigger an edge detection. | ## Outputs @@ -29,7 +29,7 @@ Take a mesh and extracts its sharp edges, using pin 1 value as a threshold angle | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/boundary_condition_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/boundary_condition_provider.md index 0155ee1949..67049c411b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/boundary_condition_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/boundary_condition_provider.md @@ -34,9 +34,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/coordinate_system_data_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/coordinate_system_data_provider.md index 3a3b8fea93..6bf3a40903 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/coordinate_system_data_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/coordinate_system_data_provider.md @@ -21,7 +21,7 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| solver_coordinate_system_ids |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Coorfinate System ids to recover used by the solver. If not set, all available materials to be recovered. | +| Pin 1| solver_coordinate_system_ids |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Coorfinate System ids to recover used by the solver. If not set, all available materials to be recovered. | | Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | @@ -35,9 +35,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/cyclic_mesh_expansion.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/cyclic_mesh_expansion.md index 17d249edd6..12ca49b8fc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/cyclic_mesh_expansion.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/cyclic_mesh_expansion.md @@ -18,7 +18,7 @@ Expand the mesh. |-------|-------|------------------|-------------| | Pin 7| sector_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | | Pin 16
Required| cyclic_support |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. | ## Outputs @@ -31,7 +31,7 @@ Expand the mesh. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/cyclic_support_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/cyclic_support_provider.md index b8ffea6cd7..3188535996 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/cyclic_support_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/cyclic_support_provider.md @@ -26,7 +26,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | data sources containing the result file. | | Pin 7| sector_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh of the first sector. | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | if this pin is set, expanding the mesh is not necessary. | -| Pin 18| sectors_to_expand |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. | +| Pin 18| sectors_to_expand |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`vector`](../../core-concepts/dpf-types.md#standard-types) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. | ## Outputs @@ -39,9 +39,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/datasources_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/datasources_provider.md index b9388ce593..cade7667f7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/datasources_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/datasources_provider.md @@ -28,7 +28,7 @@ Creates a DataSources by expanding another. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/element_types_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/element_types_provider.md index a7b998292c..fcc2695099 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/element_types_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/element_types_provider.md @@ -21,7 +21,7 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| solver_element_types_ids |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Element Type ids to recover used by the solver. If not set, all available element types to be recovered. | +| Pin 1| solver_element_types_ids |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Element Type ids to recover used by the solver. If not set, all available element types to be recovered. | | Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | @@ -35,9 +35,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/integrate_over_time_freq.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/integrate_over_time_freq.md index 0f8e5f7a19..436e7df60b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/integrate_over_time_freq.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/integrate_over_time_freq.md @@ -30,7 +30,7 @@ Integration of an input field over timefreq. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/is_cyclic.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/is_cyclic.md index 773169ce2d..5ceddd3bb3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/is_cyclic.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/is_cyclic.md @@ -29,13 +29,13 @@ This operator supports the following file types (result keys), listed by namespa | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | returns 'single_stage' or 'multi_stage' or an empty string for non cyclic model | +| **Pin 0**| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | returns 'single_stage' or 'multi_stage' or an empty string for non cyclic model | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/material_support_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/material_support_provider.md index 8c4d263110..6a2f23fa8f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/material_support_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/material_support_provider.md @@ -34,9 +34,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_info_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_info_provider.md index 567e9c1c92..99ca0f18e9 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_info_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_info_provider.md @@ -23,7 +23,7 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Optional time/frequency set ID of the mesh. | +| Pin 0| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Optional time/frequency set ID of the mesh. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | streams (mesh file container) (optional) | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | @@ -37,10 +37,10 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_property_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_property_provider.md index a77b628fda..2844272db7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_property_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_property_provider.md @@ -28,8 +28,8 @@ This operator supports the following file types (result keys), listed by namespa | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Retrieves a property field on a subset of elements or nodes. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | If the stream is null, retrieves the file path from the data sources. | -| Pin 13
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Supported property names are: "mat", "named_selection", "named_selection_names", "apdl_element_type", "section", "elprops", "keyopt_1" to "keyopt_18". | -| Pin 17| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}) | Retrieves a property at a given index or by name. For example, a named selection's number or a named selection's name. | +| Pin 13
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "mat", "named_selection", "named_selection_names", "apdl_element_type", "section", "elprops", "keyopt_1" to "keyopt_18". | +| Pin 17| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Retrieves a property at a given index or by name. For example, a named selection's number or a named selection's name. | ## Outputs @@ -41,7 +41,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_selection_manager_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_selection_manager_provider.md index c31cd4a2c8..697d5d88e7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_selection_manager_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_selection_manager_provider.md @@ -34,9 +34,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_support_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_support_provider.md index 6edc62b4a0..f084baa47d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_support_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/mesh_support_provider.md @@ -29,9 +29,9 @@ Reads the mesh support. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/property_field_provider_by_name.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/property_field_provider_by_name.md index c66cca3a8b..9566700b41 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/property_field_provider_by_name.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/property_field_provider_by_name.md @@ -19,7 +19,7 @@ Provides the property values for a set of elements for a defined property name. | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | scoping that defines the set of elements to fetch the property values for. If not specified, applied on all the elements of the mesh. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | optional if using a dataSources | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | optional if using a streamsContainer | -| Pin 13
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | property to read, that can be the following: elements_connectivity, nodes_connectivity, material, element_type, apdl_section_id, apdl_real_id, apdl_esys_id, mapdl_element_type, mapdl_element_type_id, harmonic_index, step, substep, keyopt_i (i = 1 -> 18). | +| Pin 13
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | property to read, that can be the following: elements_connectivity, nodes_connectivity, material, element_type, apdl_section_id, apdl_real_id, apdl_esys_id, mapdl_element_type, mapdl_element_type_id, harmonic_index, step, substep, keyopt_i (i = 1 -> 18). | ## Outputs @@ -31,7 +31,7 @@ Provides the property values for a set of elements for a defined property name. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/real_constants_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/real_constants_provider.md index ad4bf82b77..80559dae3c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/real_constants_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/real_constants_provider.md @@ -21,7 +21,7 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 1| solver_real_constants_ids |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Real Constant ids to recover used by the solver. If not set, all available real constants to be recovered. | +| Pin 1| solver_real_constants_ids |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Real Constant ids to recover used by the solver. If not set, all available real constants to be recovered. | | Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Result file container allowed to be kept open to cache data. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Result file path container, used if no streams are set. | @@ -35,9 +35,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/result_info_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/result_info_provider.md index 8b2a2f8998..aad782b225 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/result_info_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/result_info_provider.md @@ -39,10 +39,10 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/streams_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/streams_provider.md index 8e0c67d220..5b486d1c75 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/streams_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/streams_provider.md @@ -28,9 +28,9 @@ Creates streams (files with cache) from the data sources. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/time_freq_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/time_freq_provider.md index ffe0aa1af8..9b15f28cf6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/time_freq_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/time_freq_provider.md @@ -38,9 +38,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/time_freq_support_get_attribute.md b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/time_freq_support_get_attribute.md index 9edc5a4282..1fc97e8f0e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/metadata/time_freq_support_get_attribute.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/metadata/time_freq_support_get_attribute.md @@ -17,21 +17,21 @@ Uses the TimeFreqSupport APIs to return a given attribute of the scoping in inpu | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | -| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs". | -| Pin 2| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping. | -| Pin 3| property_identifier_2 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Additional pin for properties "set_id" and "cummulative_index": the substep id (if none, last substep is considered). | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs". | +| Pin 2| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping. | +| Pin 3| property_identifier_2 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Additional pin for properties "set_id" and "cummulative_index": the substep id (if none, last substep is considered). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", and a Field otherwise. | +| **Pin 0**| property |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", and a Field otherwise. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/max_by_component.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/max_by_component.md index dbbde5cd78..e51be42347 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/max_by_component.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/max_by_component.md @@ -16,7 +16,7 @@ Give the maximum for each element rank by comparing several fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| use_absolute_value |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | use_absolute_value | +| Pin 0
Required| use_absolute_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | use_absolute_value | | Pin 1
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs @@ -29,7 +29,7 @@ Give the maximum for each element rank by comparing several fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/max_over_phase.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/max_over_phase.md index 20d39e81e0..45f3edbbc7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/max_over_phase.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/max_over_phase.md @@ -18,8 +18,8 @@ Returns, for each entity, the maximum value of (real value * cos(theta) - imagin |-------|-------|------------------|-------------| | Pin 0
Required| real_field |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 1
Required| imaginary_field |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 2| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Should use absolute value. | -| Pin 3| phase_increment |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Phase increment (default is 10.0 degrees). | +| Pin 2| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | +| Pin 3| phase_increment |[`double`](../../core-concepts/dpf-types.md#standard-types) | Phase increment (default is 10.0 degrees). | ## Outputs @@ -31,7 +31,7 @@ Returns, for each entity, the maximum value of (real value * cos(theta) - imagin | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/max_over_time_by_entity.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/max_over_time_by_entity.md index b6192622d6..8e69498dbe 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/max_over_time_by_entity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/max_over_time_by_entity.md @@ -17,8 +17,8 @@ Evaluates maximum over time/frequency. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Should use absolute value. | -| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Do calculate amplitude. | +| Pin 3| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | +| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | ## Outputs @@ -30,8 +30,8 @@ Evaluates maximum over time/frequency. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_by_component.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_by_component.md index b0b9214389..915c7df94d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_by_component.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_by_component.md @@ -16,7 +16,7 @@ Give the minimum for each element rank by comparing several fields. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| use_absolute_value |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | use_absolute_value | +| Pin 0
Required| use_absolute_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | use_absolute_value | | Pin 1
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | ## Outputs @@ -29,7 +29,7 @@ Give the minimum for each element rank by comparing several fields. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max.md index c5fa2ee0da..ced80e7b76 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max.md @@ -29,7 +29,7 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_by_entity.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_by_entity.md index 4176189f50..8eb811b6f2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_by_entity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_by_entity.md @@ -29,7 +29,7 @@ Compute the entity-wise minimum (out 0) and maximum (out 1) through all fields o | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_by_time.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_by_time.md index cc048efa73..a28adb63da 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_by_time.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_by_time.md @@ -17,7 +17,7 @@ Evaluates minimum, maximum by time or frequency over all the entities of each fi | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 2| compute_absolute_value |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Calculate the absolute value of field entities before computing the min/max. | +| Pin 2| compute_absolute_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Calculate the absolute value of field entities before computing the min/max. | ## Outputs @@ -30,8 +30,8 @@ Evaluates minimum, maximum by time or frequency over all the entities of each fi | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_fc.md index f123145d1d..08e440226b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_fc.md @@ -29,7 +29,7 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a fields con | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_fc_inc.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_fc_inc.md index 81167b3a4f..4f87718341 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_fc_inc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_fc_inc.md @@ -29,8 +29,8 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a fields con | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_inc.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_inc.md index 4e44d4f9cc..ee206a8268 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_inc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_inc.md @@ -17,7 +17,7 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over coming field | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 17| domain_id |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 17| domain_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -32,7 +32,7 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over coming field | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_over_label_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_over_label_fc.md index 1de16ab938..ca73037a35 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_over_label_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_over_label_fc.md @@ -17,7 +17,7 @@ Create two fields (0 min 1 max) by looping over the fields container in input an | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | label name from the fields container | +| Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | label name from the fields container | ## Outputs @@ -34,7 +34,7 @@ Create two fields (0 min 1 max) by looping over the fields container in input an | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_over_time_by_entity.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_over_time_by_entity.md index 2ffc74537b..971197e5e1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_over_time_by_entity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_max_over_time_by_entity.md @@ -17,8 +17,8 @@ Evaluates minimum, maximum over time/frequency and returns those min max as well | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| compute_absolute_value |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Calculate the absolute value of field entities before computing the min/max. | -| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Do calculate amplitude. | +| Pin 3| compute_absolute_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Calculate the absolute value of field entities before computing the min/max. | +| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | ## Outputs @@ -33,8 +33,8 @@ Evaluates minimum, maximum over time/frequency and returns those min max as well | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_over_time_by_entity.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_over_time_by_entity.md index b81100e848..afc6a88ac9 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_over_time_by_entity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/min_over_time_by_entity.md @@ -17,8 +17,8 @@ Evaluates minimum over time/frequency. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Should use absolute value. | -| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Do calculate amplitude. | +| Pin 3| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | +| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | ## Outputs @@ -30,8 +30,8 @@ Evaluates minimum over time/frequency. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/phase_of_max.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/phase_of_max.md index 07bab9b8df..428c10ae4a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/phase_of_max.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/phase_of_max.md @@ -18,8 +18,8 @@ Evaluates phase of maximum. |-------|-------|------------------|-------------| | Pin 0
Required| real_field |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 1
Required| imaginary_field |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 2| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Should use absolute value. | -| Pin 3
Required| phase_increment |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Phase increment. | +| Pin 2| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | +| Pin 3
Required| phase_increment |[`double`](../../core-concepts/dpf-types.md#standard-types) | Phase increment. | ## Outputs @@ -31,7 +31,7 @@ Evaluates phase of maximum. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/time_of_max_by_entity.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/time_of_max_by_entity.md index 2f004fa030..78ca8f258a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/time_of_max_by_entity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/time_of_max_by_entity.md @@ -17,8 +17,8 @@ Evaluates time/frequency of maximum. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Should use absolute value. | -| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Do calculate amplitude. | +| Pin 3| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | +| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | ## Outputs @@ -30,8 +30,8 @@ Evaluates time/frequency of maximum. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **incremental** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/time_of_min_by_entity.md b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/time_of_min_by_entity.md index de07b7d861..83e75cdfa8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/min_max/time_of_min_by_entity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/min_max/time_of_min_by_entity.md @@ -17,8 +17,8 @@ Evaluates time/frequency of minimum. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 3| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Should use absolute value. | -| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Do calculate amplitude. | +| Pin 3| abs_value |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Should use absolute value. | +| Pin 4| compute_amplitude |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Do calculate amplitude. | ## Outputs @@ -30,7 +30,7 @@ Evaluates time/frequency of minimum. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration.md index fbf84fb39c..91f2b532d4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration.md @@ -23,17 +23,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs @@ -45,9 +45,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration_X.md index a64df84f6d..72f22da538 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration_X.md @@ -21,14 +21,14 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration_Y.md index 451d185ac1..9bd280686f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration_Y.md @@ -21,14 +21,14 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration_Z.md index 6dc0a1f036..72ba64e274 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/acceleration_Z.md @@ -21,14 +21,14 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/accu_eqv_creep_strain.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/accu_eqv_creep_strain.md index 5f3ac916f2..0ce7440190 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/accu_eqv_creep_strain.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/accu_eqv_creep_strain.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/accu_eqv_plastic_strain.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/accu_eqv_plastic_strain.md index bb05b107c9..bef819bef7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/accu_eqv_plastic_strain.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/accu_eqv_plastic_strain.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/add_rigid_body_motion.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/add_rigid_body_motion.md index ce8270d900..617cd8ddc1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/add_rigid_body_motion.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/add_rigid_body_motion.md @@ -32,7 +32,7 @@ Adds a given rigid translation, center and rotation from a displacement field. T | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/add_rigid_body_motion_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/add_rigid_body_motion_fc.md index 16656a056f..d49c5740d5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/add_rigid_body_motion_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/add_rigid_body_motion_fc.md @@ -32,7 +32,7 @@ Adds a given rigid translation, center and rotation from a displacement field. T | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/artificial_hourglass_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/artificial_hourglass_energy.md index 1b6dbf887a..7e1889a17c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/artificial_hourglass_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/artificial_hourglass_energy.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_force.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_force.md index 301f8e4bff..49f0279757 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_force.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_force.md @@ -22,11 +22,11 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -38,7 +38,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_plastic_strain.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_plastic_strain.md index 3d637adbad..b3b04b93be 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_plastic_strain.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_plastic_strain.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_stress.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_stress.md index cbcc8e5b22..97e504c849 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_stress.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_stress.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_total_strain.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_total_strain.md index 4abfe47f76..3b8f62b1e4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_total_strain.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_axial_total_strain.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_rs_shear_stress.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_rs_shear_stress.md index e7236e0b3e..bd6be797a2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_rs_shear_stress.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_rs_shear_stress.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_s_bending_moment.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_s_bending_moment.md index 6d9bc2146d..f8d4a217f5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_s_bending_moment.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_s_bending_moment.md @@ -22,11 +22,11 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -38,7 +38,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_s_shear_force.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_s_shear_force.md index 52d563df64..6433e7df46 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_s_shear_force.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_s_shear_force.md @@ -22,11 +22,11 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -38,7 +38,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_t_bending_moment.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_t_bending_moment.md index 0e0dc7526d..738009dd5d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_t_bending_moment.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_t_bending_moment.md @@ -22,11 +22,11 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -38,7 +38,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_t_shear_force.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_t_shear_force.md index 373bd2eaf5..12d6825ea1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_t_shear_force.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_t_shear_force.md @@ -22,11 +22,11 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -38,7 +38,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_torsional_moment.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_torsional_moment.md index 11bb6c3528..7749dce0ed 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_torsional_moment.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_torsional_moment.md @@ -22,11 +22,11 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -38,7 +38,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_tr_shear_stress.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_tr_shear_stress.md index 331199023a..1b47a003d6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_tr_shear_stress.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/beam_tr_shear_stress.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | integration point where the result will be read from. Default value: 0 (first integration point). | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 6| integration_point |[`int32`](../../core-concepts/dpf-types.md#standard-types) | integration point where the result will be read from. Default value: 0 (first integration point). | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/cgns_result_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/cgns_result_provider.md index 2fa71c7ea0..76005fca3b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/cgns_result_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/cgns_result_provider.md @@ -16,12 +16,12 @@ Read/compute names result from result streams. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. The scoping's location indicates whether nodes or elements are asked. Using scopings container enables to split the result fields container in domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 17| result_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | name of the result to read. By default the name of the operator is taken. | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Optional zone name/Id of the mesh. | +| Pin 17| result_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | name of the result to read. By default the name of the operator is taken. | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Optional zone name/Id of the mesh. | ## Outputs @@ -33,7 +33,7 @@ Read/compute names result from result streams. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/cms_dst_table_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/cms_dst_table_provider.md index 912c631c7a..3a6e14030f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/cms_dst_table_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/cms_dst_table_provider.md @@ -28,7 +28,7 @@ Read CST table from a subfile. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/cms_matrices_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/cms_matrices_provider.md index 3f9dcc93ae..867b539153 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/cms_matrices_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/cms_matrices_provider.md @@ -17,7 +17,7 @@ Read reduced matrices for cms elements. Extract stiffness, damping, mass matrice | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain at list one subfile). | -| Pin 200
Required| matrix_form |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If this pin i set to true, data are return as matrix form. | +| Pin 200
Required| matrix_form |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin i set to true, data are return as matrix form. | ## Outputs @@ -29,7 +29,7 @@ Read reduced matrices for cms elements. Extract stiffness, damping, mass matrice | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/cms_subfile_info_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/cms_subfile_info_provider.md index 01f471e2e9..b2c22b507d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/cms_subfile_info_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/cms_subfile_info_provider.md @@ -17,21 +17,21 @@ Read required information from a subfile. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Data_sources (must contain at least one subfile). | -| Pin 200
Required| cms_subfile_data |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If this pin i set to true, data are return in a field. | -| Pin 300| output_maxdof_on_masternodes |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If this pin is set to true, compute and add field with max degrees of freedom on master nodes | +| Pin 200
Required| cms_subfile_data |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin i set to true, data are return in a field. | +| Pin 300| output_maxdof_on_masternodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, compute and add field with max degrees of freedom on master nodes | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| int32 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | returns integer values in the order : unit system used, stiffness matrix present key, damping matrix present key, mass matrix present key, number of master nodes, number of virtual nodes | +| **Pin 0**| int32 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | returns integer values in the order : unit system used, stiffness matrix present key, damping matrix present key, mass matrix present key, number of master nodes, number of virtual nodes | | **Pin 1**| field |[`property_field`](../../core-concepts/dpf-types.md#property-field) | returns integer values in the order : number of load vectors (nvects), number of nodes (nnod), number of virtual nodes (nvnodes), number of modes (nvmodes) | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/co_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/co_energy.md index 893d9abf61..5492cf694f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/co_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/co_energy.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_invariant_terms_motion.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_invariant_terms_motion.md index 0dfae489d8..8959b9b89f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_invariant_terms_motion.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_invariant_terms_motion.md @@ -21,7 +21,7 @@ Set the required data for the invariant terms computation (reduced matrices, lum | Pin 2
Required| lumped_mass |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | | Pin 3
Required| model_data |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | data describing the finite element model | | Pin 4
Required| field_coordinates |[`field`](../../core-concepts/dpf-types.md#field) | coordinates of all nodes | -| Pin 5
Required| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 5
Required| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -31,25 +31,25 @@ Set the required data for the invariant terms computation (reduced matrices, lum | **Pin 1**| mode_shapes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the mode shapes, which are CST and NOR for the cms method | | **Pin 2**| lumped_mass |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | | **Pin 3**| field_coordinates_and_euler_angles |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | coordinates and euler angles of all nodes | -| **Pin 4**| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 5**| used_node_index |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 6**| eigenvalue |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 7**| translational_mode_shape |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 8**| rotational_mode_shape |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 9**| invrt_1 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 10**| invrt_2 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 11**| invrt_3 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 12**| invrt_4 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 13**| invrt_5 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 14**| invrt_6 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 15**| invrt_7 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 16**| invrt_8 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 4**| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 5**| used_node_index |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 6**| eigenvalue |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 7**| translational_mode_shape |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 8**| rotational_mode_shape |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 9**| invrt_1 |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 10**| invrt_2 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 11**| invrt_3 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 12**| invrt_4 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 13**| invrt_5 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 14**| invrt_6 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 15**| invrt_7 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 16**| invrt_8 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_invariant_terms_rbd.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_invariant_terms_rbd.md index 3b4ab4ab4d..6b53b22de2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_invariant_terms_rbd.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_invariant_terms_rbd.md @@ -22,10 +22,10 @@ Set the required data for the invariant terms computation (reduced matrices, lum | Pin 3
Required| model_data |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | data describing the finite element model | | Pin 4
Required| center_of_mass |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 5
Required| inertia_relief |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | inertia matrix | -| Pin 6
Required| model_size |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | model size | +| Pin 6
Required| model_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | model size | | Pin 7
Required| field_coordinates |[`field`](../../core-concepts/dpf-types.md#field) | coordinates of all nodes | -| Pin 8
Required| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 9| constraint_mode_check |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, the orthogonality of the constraint modes are checked. Default is false. | +| Pin 8
Required| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 9| constraint_mode_check |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, the orthogonality of the constraint modes are checked. Default is false. | ## Outputs @@ -35,31 +35,31 @@ Set the required data for the invariant terms computation (reduced matrices, lum | **Pin 1**| center_of_mass |[`field`](../../core-concepts/dpf-types.md#field) | center of mass of the body | | **Pin 2**| inertia_relief |[`field`](../../core-concepts/dpf-types.md#field) | inertia matrix | | **Pin 3**| model_size |[`property_field`](../../core-concepts/dpf-types.md#property-field) | | -| **Pin 4**| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 5**| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | translational and rotational shape functions | +| **Pin 4**| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 5**| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | | **Pin 6**| k_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | **Pin 7**| mass_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | **Pin 8**| c_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | **Pin 9**| rhs |[`field`](../../core-concepts/dpf-types.md#field) | | -| **Pin 10**| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 11**| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 12**| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 13**| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 14**| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 15**| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 16**| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 17**| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 18**| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 19**| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 20**| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 21**| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 22**| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 10**| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 11**| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 12**| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 13**| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 14**| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 15**| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 16**| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 17**| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 18**| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 19**| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 20**| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 21**| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 22**| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress.md index 421c81eb7d..ae010a670b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress.md @@ -19,7 +19,7 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs @@ -32,8 +32,8 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_1.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_1.md index 418d42319e..242a2f95c8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_1.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_1.md @@ -19,7 +19,7 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs @@ -32,8 +32,8 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_2.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_2.md index 3643df34c4..c36f2a1f77 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_2.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_2.md @@ -19,7 +19,7 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs @@ -32,8 +32,8 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_3.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_3.md index b01dbecbf3..6ad5128613 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_3.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_3.md @@ -19,7 +19,7 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs @@ -32,8 +32,8 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_X.md index 04afa10629..fd19f7570b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_X.md @@ -19,7 +19,7 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs @@ -32,8 +32,8 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_XY.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_XY.md index 6173408457..2fcfe1d466 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_XY.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_XY.md @@ -19,7 +19,7 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs @@ -32,8 +32,8 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_XZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_XZ.md index 150310c183..26c9bb681d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_XZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_XZ.md @@ -19,7 +19,7 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs @@ -32,8 +32,8 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_Y.md index 8cbd806fa9..6e3dc05ee7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_Y.md @@ -19,7 +19,7 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs @@ -32,8 +32,8 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_YZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_YZ.md index f18dc06577..9e4fda2ce4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_YZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_YZ.md @@ -19,7 +19,7 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs @@ -32,8 +32,8 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_Z.md index 32b28260b7..801073f45d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_Z.md @@ -19,7 +19,7 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs @@ -32,8 +32,8 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_von_mises.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_von_mises.md index 8ca8f36a12..2dc1e0c8d6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_von_mises.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_stress_von_mises.md @@ -19,7 +19,7 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Needed to get mesh and material ids. Optional if a data_sources have been connected. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Needed to get mesh and material ids. Optional if a streams_container have been connected. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10
Required| strain |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the elastic strain field (element nodal). | ## Outputs @@ -32,8 +32,8 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain.md index da1dc3a205..c9fa1052f3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain.md @@ -24,14 +24,14 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | | Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs @@ -44,8 +44,8 @@ Euler Angles need to be included in the database. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_1.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_1.md index 03926ff708..63b8c88a9b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_1.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_1.md @@ -24,14 +24,14 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | | Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs @@ -44,8 +44,8 @@ Euler Angles need to be included in the database. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_2.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_2.md index da31120a87..6ff84e711b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_2.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_2.md @@ -24,14 +24,14 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | | Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs @@ -44,8 +44,8 @@ Euler Angles need to be included in the database. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_3.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_3.md index b4f54b4f3b..27cbbafa34 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_3.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_3.md @@ -24,14 +24,14 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | | Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs @@ -44,8 +44,8 @@ Euler Angles need to be included in the database. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_X.md index 1da1756e64..c948ac6935 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_X.md @@ -24,14 +24,14 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | | Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs @@ -44,8 +44,8 @@ Euler Angles need to be included in the database. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_XY.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_XY.md index 7610a9930d..b2410315d2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_XY.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_XY.md @@ -24,14 +24,14 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | | Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs @@ -44,8 +44,8 @@ Euler Angles need to be included in the database. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_XZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_XZ.md index 2a9f95fe8f..5db619997f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_XZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_XZ.md @@ -24,14 +24,14 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | | Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs @@ -44,8 +44,8 @@ Euler Angles need to be included in the database. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_Y.md index cb8c99bcd0..fc5919f6a6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_Y.md @@ -24,14 +24,14 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | | Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs @@ -44,8 +44,8 @@ Euler Angles need to be included in the database. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_YZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_YZ.md index 974da1d8ad..6dc7d367d0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_YZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_YZ.md @@ -24,14 +24,14 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | | Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs @@ -44,8 +44,8 @@ Euler Angles need to be included in the database. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_Z.md index 709ce020c1..6d373a1a79 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/compute_total_strain_Z.md @@ -24,14 +24,14 @@ Euler Angles need to be included in the database. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). | | Pin 1| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | The element scoping on which the result is computed. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | Optional if a mesh or a data_sources have been connected. Required if no displacement input have been connected. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Optional if a mesh or a streams_container have been connected, or if the displacement's field has a mesh support. Required if no displacement input have been connected. | -| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to extrapolate the data from the integration points to the nodes. | -| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | +| Pin 5| extrapolate |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to extrapolate the data from the integration points to the nodes. | +| Pin 6| nonlinear |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Whether to use nonlinear geometry or nonlinear material (1 = large strain, 2 = hyperelasticity). | | Pin 7| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The underlying mesh. Optional if a data_sources or a streams_container have been connected, or if the displacement's field has a mesh support. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Average the Elemental Nodal result to the requested location. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Average the Elemental Nodal result to the requested location. | | Pin 10| displacement |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. | ## Outputs @@ -44,8 +44,8 @@ Euler Angles need to be included in the database. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_fluid_penetration_pressure.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_fluid_penetration_pressure.md index ab4b942587..9dfc921857 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_fluid_penetration_pressure.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_fluid_penetration_pressure.md @@ -22,21 +22,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -48,9 +48,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_friction_stress.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_friction_stress.md index 676effccf0..e48a75a82b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_friction_stress.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_friction_stress.md @@ -22,21 +22,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -48,9 +48,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_gap_distance.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_gap_distance.md index cb77fb7497..8e306633b0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_gap_distance.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_gap_distance.md @@ -22,21 +22,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -48,9 +48,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_penetration.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_penetration.md index 103b5b0a1d..09a8c7df86 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_penetration.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_penetration.md @@ -23,21 +23,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -49,9 +49,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_pressure.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_pressure.md index 0e4aac985b..46b836c823 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_pressure.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_pressure.md @@ -22,21 +22,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -48,9 +48,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_sliding_distance.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_sliding_distance.md index 3de30925f6..047a4fd51d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_sliding_distance.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_sliding_distance.md @@ -22,21 +22,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -48,9 +48,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_status.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_status.md index 0f5d7a4e48..ac6038be18 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_status.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_status.md @@ -22,21 +22,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -48,9 +48,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_surface_heat_flux.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_surface_heat_flux.md index 7cbdf78c25..b4ee7cf3a3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_surface_heat_flux.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_surface_heat_flux.md @@ -22,21 +22,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -48,9 +48,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_total_stress.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_total_stress.md index f72d4f1676..10a587c3f1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_total_stress.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/contact_total_stress.md @@ -22,21 +22,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -48,9 +48,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/coordinate_system.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/coordinate_system.md index ff42223fc9..59f1b3a77e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/coordinate_system.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/coordinate_system.md @@ -21,7 +21,7 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| cs_id |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0
Required| cs_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | @@ -35,7 +35,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/coordinates.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/coordinates.md index f684b77a9e..b66ab1fc0b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/coordinates.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/coordinates.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/creep_strain_energy_density.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/creep_strain_energy_density.md index 87221a39ca..48381dcf38 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/creep_strain_energy_density.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/creep_strain_energy_density.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/current_density.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/current_density.md index e6a07ec900..3d7700e378 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/current_density.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/current_density.md @@ -29,12 +29,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -47,9 +47,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/cyclic_analytic_seqv_max.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/cyclic_analytic_seqv_max.md index e3c6ff3d74..6e8bb3c6ca 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/cyclic_analytic_seqv_max.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/cyclic_analytic_seqv_max.md @@ -16,10 +16,10 @@ Compute the maximum of the Von Mises equivalent stress that can be expected on 3 | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field container with the base and duplicate sectors | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | default is true | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | default is true | | Pin 16
Required| cyclic_support |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | | ## Outputs @@ -32,10 +32,10 @@ Compute the maximum of the Von Mises equivalent stress that can be expected on 3 | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/cyclic_analytic_usum_max.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/cyclic_analytic_usum_max.md index 094100fb4d..d91bf97b49 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/cyclic_analytic_usum_max.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/cyclic_analytic_usum_max.md @@ -16,10 +16,10 @@ Compute the maximum of the total deformation that can be expected on 360 degrees | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field container with the base and duplicate sectors | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | default is true | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | default is true | | Pin 16
Required| cyclic_support |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | | ## Outputs @@ -32,10 +32,10 @@ Compute the maximum of the total deformation that can be expected on 360 degrees | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/cyclic_expansion.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/cyclic_expansion.md index ada64615f4..4b7c5cf56a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/cyclic_expansion.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/cyclic_expansion.md @@ -16,17 +16,17 @@ Expand cyclic results from a fieldsContainer for given sets, sectors and scoping | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 2
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field container with the base and duplicate sectors | -| Pin 3| harmonic_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | default is true | +| Pin 3| harmonic_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | default is true | | Pin 6| map_size_scoping_out |[`umap`](../../core-concepts/dpf-types.md#umap) | map provider by scoping adapter | -| Pin 7| normalization_factor |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| merge_stages |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 7| normalization_factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| merge_stages |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 16
Required| cyclic_support |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0) | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0) | ## Outputs @@ -38,10 +38,10 @@ Expand cyclic results from a fieldsContainer for given sets, sectors and scoping | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/density.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/density.md index 5e1bf01177..0fe10baca8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/density.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/density.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement.md index 928fcc64b8..a0949d0484 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement.md @@ -23,17 +23,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs @@ -45,9 +45,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement_X.md index e488bc5b55..3d059eb5fe 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement_X.md @@ -21,14 +21,14 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement_Y.md index 5214f9eb00..65ad73d755 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement_Y.md @@ -21,14 +21,14 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement_Z.md index 5722fcbab0..d58b80f0f6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/displacement_Z.md @@ -21,14 +21,14 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/div_lighthill_tensor.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/div_lighthill_tensor.md index cd1a45621d..33b22b007b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/div_lighthill_tensor.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/div_lighthill_tensor.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/dynamic_viscosity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/dynamic_viscosity.md index 75aa10ba7b..bfe8e122a6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/dynamic_viscosity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/dynamic_viscosity.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain.md index ef2b3fc32b..ff8e9e11e9 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain.md @@ -22,21 +22,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -48,9 +48,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_X.md index e0f9d23571..3728dda926 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_X.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_XY.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_XY.md index 85ddba4886..a4cd5d5c03 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_XY.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_XY.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_XZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_XZ.md index e890b7b4fb..597cf1f188 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_XZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_XZ.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_Y.md index e632f75fb3..98697ad0e8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_Y.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_YZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_YZ.md index 10e75ee8ff..cfe2ad2a3f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_YZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_YZ.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_Z.md index b19306bd2b..9ce3de05b2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_Z.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_energy_density.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_energy_density.md index 1ff089555a..ca9885fc20 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_energy_density.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_energy_density.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_eqv.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_eqv.md index 6713d7c53c..b231c9ece9 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_eqv.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_eqv.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_intensity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_intensity.md index 08a745f87e..e6ec0859c4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_intensity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_intensity.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_max_shear.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_max_shear.md index 3594859710..6239b55668 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_max_shear.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_max_shear.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_principal_1.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_principal_1.md index 87672f2109..c6235f95c5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_principal_1.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_principal_1.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_principal_2.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_principal_2.md index 9e5a26881d..e7981a3370 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_principal_2.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_principal_2.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_principal_3.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_principal_3.md index 63de5041f3..f16b38a9d8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_principal_3.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_principal_3.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md index deba38f210..b58b14652d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md @@ -30,7 +30,7 @@ read Euler angles on elements from the result file and rotate the fields in the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field.md index 200bfabe58..aeef51abb6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field_X.md index ce9c7f1eea..338442d589 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field_X.md @@ -16,16 +16,16 @@ Read/compute electric field X component of the vector (1st component) by calling | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute electric field X component of the vector (1st component) by calling | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field_Y.md index bde07dbb05..d674086ad3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field_Y.md @@ -16,16 +16,16 @@ Read/compute electric field Y component of the vector (2nd component) by calling | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute electric field Y component of the vector (2nd component) by calling | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field_Z.md index 74b89cbc31..3a0466df67 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_field_Z.md @@ -16,16 +16,16 @@ Read/compute electric field Z component of the vector (3rd component) by calling | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute electric field Z component of the vector (3rd component) by calling | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density.md index 18feb8099a..620a869d74 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density_X.md index 00dfd7e172..0cba48dab3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density_X.md @@ -16,16 +16,16 @@ Read/compute Electric flux density X component of the vector (1st component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute Electric flux density X component of the vector (1st component) by | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density_Y.md index de153d8e6d..60f8608ad2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density_Y.md @@ -16,16 +16,16 @@ Read/compute Electric flux density Y component of the vector (2nd component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute Electric flux density Y component of the vector (2nd component) by | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density_Z.md index 301a702962..02bc4e8e27 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_flux_density_Z.md @@ -16,16 +16,16 @@ Read/compute Electric flux density Z component of the vector (3rd component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute Electric flux density Z component of the vector (3rd component) by | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_potential.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_potential.md index daa844694c..cba1988fd4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_potential.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/electric_potential.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -39,9 +39,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/element_centroids.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/element_centroids.md index b1062f5efd..ddc5cd777e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/element_centroids.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/element_centroids.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -39,9 +39,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/element_nodal_forces.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/element_nodal_forces.md index 8610bcabdf..299019bfa9 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/element_nodal_forces.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/element_nodal_forces.md @@ -22,22 +22,22 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | -| Pin 200| split_force_components |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If this pin is set to true, the output fields container splits the ENF by degree of freedom ("dof" label, 0 for translation, 1 for rotation, 2 for temperature) and derivative order ("derivative_order" label, 0 for stiffness terms, 1 for damping terms and 2 for inertial terms). Default is false. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 200| split_force_components |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, the output fields container splits the ENF by degree of freedom ("dof" label, 0 for translation, 1 for rotation, 2 for temperature) and derivative order ("derivative_order" label, 0 for stiffness terms, 1 for damping terms and 2 for inertial terms). Default is false. | ## Outputs @@ -49,9 +49,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations.md index a5ed2b90fb..24ed53e608 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations_X.md index 3a8d6a5410..40142b8434 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations_X.md @@ -16,16 +16,16 @@ Read/compute element euler angles X component of the vector (1st component) by c | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute element euler angles X component of the vector (1st component) by c | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations_Y.md index 537bcc426b..b35860a525 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations_Y.md @@ -16,16 +16,16 @@ Read/compute element euler angles Y component of the vector (2nd component) by c | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute element euler angles Y component of the vector (2nd component) by c | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations_Z.md index c5af22744c..c9ef324a03 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/element_orientations_Z.md @@ -16,16 +16,16 @@ Read/compute element euler angles Z component of the vector (3rd component) by c | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute element euler angles Z component of the vector (3rd component) by c | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elemental_heat_generation.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elemental_heat_generation.md index bcfa90da09..0bbdb787fd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elemental_heat_generation.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elemental_heat_generation.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -39,9 +39,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elemental_mass.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elemental_mass.md index cf4483bec2..b27886cac4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elemental_mass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elemental_mass.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -39,9 +39,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/elemental_volume.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/elemental_volume.md index 25b58d84f8..1815808b86 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/elemental_volume.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/elemental_volume.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/enf_rotation_by_euler_nodes.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/enf_rotation_by_euler_nodes.md index 96a6f0af04..fe5bbd6e64 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/enf_rotation_by_euler_nodes.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/enf_rotation_by_euler_nodes.md @@ -30,7 +30,7 @@ read Euler angles on elements from the result file and rotate the fields in the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/enthalpy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/enthalpy.md index 17ba215146..52d5661aee 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/enthalpy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/enthalpy.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/entropy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/entropy.md index aadae5b2a0..742f835111 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/entropy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/entropy.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/epsilon.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/epsilon.md index 7d3fc0bdcb..1ad8732c8a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/epsilon.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/epsilon.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/equivalent_mass.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/equivalent_mass.md index 1cb13cb209..11c4db36da 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/equivalent_mass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/equivalent_mass.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 6| all_dofs |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | default is false. | +| Pin 6| all_dofs |[`bool`](../../core-concepts/dpf-types.md#standard-types) | default is false. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/equivalent_radiated_power.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/equivalent_radiated_power.md index 9845cdef94..9e0acc0e68 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/equivalent_radiated_power.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/equivalent_radiated_power.md @@ -18,12 +18,12 @@ Compute the Equivalent Radiated Power (ERP) |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | the input field container expects displacements fields | | Pin 1
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | the mesh region in this pin has to be boundary or skin mesh | -| Pin 2
Required| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping) | load step number (if it's specified, the ERP is computed only on the substeps of this step) or time scoping | -| Pin 3
Required| mass_density |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | mass density (if it's not specified, default value of the air is applied). | -| Pin 4
Required| speed_of_sound |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | speed of sound (if it's not specified, default value of the speed of sound in the air is applied). | -| Pin 5
Required| erp_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if this pin is set to 0, the classical ERP is computed, 1 the corrected ERP is computed (a mesh of one face has to be given in the pin 1) and 2 the enhanced ERP is computed. Default is 0. | -| Pin 6
Required| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if this pin is set to true, the ERP level in dB is computed | -| Pin 7
Required| factor |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | erp reference value. Default is 1E-12 | +| Pin 2
Required| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | load step number (if it's specified, the ERP is computed only on the substeps of this step) or time scoping | +| Pin 3
Required| mass_density |[`double`](../../core-concepts/dpf-types.md#standard-types) | mass density (if it's not specified, default value of the air is applied). | +| Pin 4
Required| speed_of_sound |[`double`](../../core-concepts/dpf-types.md#standard-types) | speed of sound (if it's not specified, default value of the speed of sound in the air is applied). | +| Pin 5
Required| erp_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | if this pin is set to 0, the classical ERP is computed, 1 the corrected ERP is computed (a mesh of one face has to be given in the pin 1) and 2 the enhanced ERP is computed. Default is 0. | +| Pin 6
Required| boolean |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if this pin is set to true, the ERP level in dB is computed | +| Pin 7
Required| factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | erp reference value. Default is 1E-12 | ## Outputs @@ -35,7 +35,7 @@ Compute the Equivalent Radiated Power (ERP) | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/eqv_stress_parameter.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/eqv_stress_parameter.md index 957de70d8b..587c391edb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/eqv_stress_parameter.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/eqv_stress_parameter.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/erp_radiation_efficiency.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/erp_radiation_efficiency.md index 02bccefcee..ca0ecebdf0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/erp_radiation_efficiency.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/erp_radiation_efficiency.md @@ -18,9 +18,9 @@ Compute the radiation efficiency (enhanced erp divided by classical erp) |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | the input field container expects displacements fields | | Pin 1
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | the meshes region in this pin has to be boundary or skin mesh | -| Pin 2
Required| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping) | load step number (if it's specified, the ERP is computed only on the substeps of this step) or time scoping | -| Pin 3
Required| mass_density |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | mass density (if it's not specified, default value of the air is applied). | -| Pin 4
Required| speed_of_sound |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | speed of sound (if it's not specified, default value of the speed of sound in the air is applied). | +| Pin 2
Required| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | load step number (if it's specified, the ERP is computed only on the substeps of this step) or time scoping | +| Pin 3
Required| mass_density |[`double`](../../core-concepts/dpf-types.md#standard-types) | mass density (if it's not specified, default value of the air is applied). | +| Pin 4
Required| speed_of_sound |[`double`](../../core-concepts/dpf-types.md#standard-types) | speed of sound (if it's not specified, default value of the speed of sound in the air is applied). | ## Outputs @@ -32,7 +32,7 @@ Compute the radiation efficiency (enhanced erp divided by classical erp) | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/euler_load_buckling.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/euler_load_buckling.md index 9b08772e73..e526b6a0a3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/euler_load_buckling.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/euler_load_buckling.md @@ -33,7 +33,7 @@ Computing Euler's Critical Load. Formula: Ncr = n*E*I*pi*pi /(L*L) | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/euler_nodes.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/euler_nodes.md index ec7991e3b8..bbfa592a83 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/euler_nodes.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/euler_nodes.md @@ -24,8 +24,8 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), [`stream`](../../core-concepts/dpf-types.md#stream) | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | -| Pin 5
Required| filter_zeros |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, then the field will only contain the scoping if any rotation is not zero. (default is false). | -| Pin 6
Required| coord_and_euler |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, then the field has ncomp=6 with 3 coordinates and 3 Euler angles, else there is only the Euler angles (default is true). | +| Pin 5
Required| filter_zeros |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, then the field will only contain the scoping if any rotation is not zero. (default is false). | +| Pin 6
Required| coord_and_euler |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, then the field has ncomp=6 with 3 coordinates and 3 Euler angles, else there is only the Euler angles (default is true). | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs @@ -38,7 +38,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation.md index 80d6234f69..f3feb57ce6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation_X.md index a994ff567f..3c4965d0b4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation_X.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation_XY.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation_XY.md index 2b604b1318..68180f7d6d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation_XY.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation_XY.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation_XZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation_XZ.md index 62f71460c4..f5835d8a6b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation_XZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_deformation_XZ.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure.md index 289e316ac7..8903b64bf7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure_X.md index db8eb93d91..078deae39b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure_X.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure_XY.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure_XY.md index 18630466a0..6a7fc2b1f4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure_XY.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure_XY.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure_XZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure_XZ.md index beeb4ada9c..6c62ce8f66 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure_XZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_inelastic_closure_XZ.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress.md index 444b200e24..d1d3821619 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress_X.md index e3e13918b9..d7d3fc6589 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress_X.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress_XY.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress_XY.md index b715b848d2..00b792527c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress_XY.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress_XY.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress_XZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress_XZ.md index 1e00843c97..a14bff5422 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress_XZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_stress_XZ.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure.md index 79450707a7..cb165f4b31 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure_X.md index 6685e26908..eff6293e49 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure_X.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure_XY.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure_XY.md index 7e74ff4d03..721ee94735 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure_XY.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure_XY.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure_XZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure_XZ.md index 4145ed4b93..0450f2a647 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure_XZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/gasket_thermal_closure_XZ.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_added_mass.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_added_mass.md index e381ac8186..e4bde280bb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_added_mass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_added_mass.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_added_mass_pct.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_added_mass_pct.md index 0535e03145..c3ac5c40de 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_added_mass_pct.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_added_mass_pct.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_center_mass.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_center_mass.md index 8bb17460a1..bd59fff549 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_center_mass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_center_mass.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_energy_ratio.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_energy_ratio.md index 8f0e95ce84..947c60f41b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_energy_ratio.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_energy_ratio.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_energy_ratio_wo_eroded.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_energy_ratio_wo_eroded.md index 439ea03173..f58d41b785 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_energy_ratio_wo_eroded.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_energy_ratio_wo_eroded.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_eroded_hourglass_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_eroded_hourglass_energy.md index 2d8adf1346..876eb64fb7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_eroded_hourglass_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_eroded_hourglass_energy.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_eroded_internal_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_eroded_internal_energy.md index 2df95af848..cca2569ebc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_eroded_internal_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_eroded_internal_energy.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_eroded_kinetic_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_eroded_kinetic_energy.md index 77bff11255..9237c4af20 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_eroded_kinetic_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_eroded_kinetic_energy.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_external_work.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_external_work.md index 37b793bc38..71aef53c39 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_external_work.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_external_work.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_hourglass_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_hourglass_energy.md index 51724788fd..ece6db65bd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_hourglass_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_hourglass_energy.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_internal_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_internal_energy.md index 821d1a9b4c..4af2732cb7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_internal_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_internal_energy.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_joint_internal_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_joint_internal_energy.md index fd7a0cb076..5f90580060 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_joint_internal_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_joint_internal_energy.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_kinetic_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_kinetic_energy.md index b4475f25cd..4a5f051d96 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_kinetic_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_kinetic_energy.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_rigid_body_stopper_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_rigid_body_stopper_energy.md index 7ecdf963bd..faa6c02cd6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_rigid_body_stopper_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_rigid_body_stopper_energy.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_sliding_interface_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_sliding_interface_energy.md index 207eefd209..eb561390e6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_sliding_interface_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_sliding_interface_energy.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_spring_damper_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_spring_damper_energy.md index f754f6874c..eb523b12c1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_spring_damper_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_spring_damper_energy.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_system_damping_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_system_damping_energy.md index 1c77538c1f..08c69ae43b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_system_damping_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_system_damping_energy.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_time_step.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_time_step.md index f4c5d9cc0a..94b7a00f23 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_time_step.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_time_step.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_total_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_total_energy.md index da05ee32c1..4d7616366b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_total_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_total_energy.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_total_mass.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_total_mass.md index 7acbed957b..6d6767beaf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_total_mass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_total_mass.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_velocity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_velocity.md index f171615eeb..1e7c60c66c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/global_velocity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/global_velocity.md @@ -24,7 +24,7 @@ This operator supports the following file types (result keys), listed by namespa |-------|-------|------------------|-------------| | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -36,7 +36,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux.md index 8b26219b55..443eb1c430 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux.md @@ -23,21 +23,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -49,9 +49,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux_X.md index eb4c69afdb..65cd5e72bf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux_X.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux_Y.md index d52dcc9f43..ba027611cb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux_Y.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux_Z.md index 6bba88123d..9e3136c2ad 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/heat_flux_Z.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/hydrostatic_pressure.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/hydrostatic_pressure.md index f051387ddd..5134c2f181 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/hydrostatic_pressure.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/hydrostatic_pressure.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/incremental_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/incremental_energy.md index 7c3f4a3a23..1012ce73f3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/incremental_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/incremental_energy.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/initial_coordinates.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/initial_coordinates.md index 61c31b0563..b12c5cddb4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/initial_coordinates.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/initial_coordinates.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_area.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_area.md index 7c3a2b7036..cfe2688271 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_area.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_area.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_force.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_force.md index e78e5d0987..8d867b65e3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_force.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_force.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_mass.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_mass.md index 50561e7b53..187d930327 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_mass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_mass.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_moment.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_moment.md index 7886546d87..4141d4a55b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_moment.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_contact_moment.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_resultant_contact_force.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_resultant_contact_force.md index 3ca9f2b2ee..280445b3a5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_resultant_contact_force.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/interface_resultant_contact_force.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_force_reaction.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_force_reaction.md index 807573e380..78ab2d5657 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_force_reaction.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_force_reaction.md @@ -16,12 +16,12 @@ Read/compute joint force reaction by calling the readers defined by the datasour | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute joint force reaction by calling the readers defined by the datasour | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_moment_reaction.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_moment_reaction.md index 902ed36f3c..0bdfd57401 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_moment_reaction.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_moment_reaction.md @@ -16,12 +16,12 @@ Read/compute joint moment reaction by calling the readers defined by the datasou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute joint moment reaction by calling the readers defined by the datasou | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_acceleration.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_acceleration.md index af80203713..8d99b2debd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_acceleration.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_acceleration.md @@ -16,12 +16,12 @@ Read/compute joint relative acceleration by calling the readers defined by the d | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute joint relative acceleration by calling the readers defined by the d | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_angular_acceleration.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_angular_acceleration.md index 1e8ad12199..1b5af1fe74 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_angular_acceleration.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_angular_acceleration.md @@ -16,12 +16,12 @@ Read/compute joint relative angular acceleration by calling the readers defined | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute joint relative angular acceleration by calling the readers defined | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_angular_velocity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_angular_velocity.md index d75aa1954b..1f42939f49 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_angular_velocity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_angular_velocity.md @@ -16,12 +16,12 @@ Read/compute joint relative angular velocity by calling the readers defined by t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute joint relative angular velocity by calling the readers defined by t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_displacement.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_displacement.md index 463be1daa1..f9df1d440c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_displacement.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_displacement.md @@ -16,12 +16,12 @@ Read/compute joint relative displacement by calling the readers defined by the d | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute joint relative displacement by calling the readers defined by the d | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_rotation.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_rotation.md index 76f8c2a270..3a11670859 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_rotation.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_rotation.md @@ -16,12 +16,12 @@ Read/compute joint relative rotation by calling the readers defined by the datas | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute joint relative rotation by calling the readers defined by the datas | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_velocity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_velocity.md index 7cd3c970a4..699fcc15ab 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_velocity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/joint_relative_velocity.md @@ -16,12 +16,12 @@ Read/compute joint relative velocity by calling the readers defined by the datas | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute joint relative velocity by calling the readers defined by the datas | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/kinetic_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/kinetic_energy.md index e8eb460203..4f65e1e8cc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/kinetic_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/kinetic_energy.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mach_number.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mach_number.md index d77973a470..82ebbd7f8b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mach_number.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mach_number.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field.md index 0f2c8c6355..9abb4f96f0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field_X.md index ab761da0fc..4db0b3d85f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field_X.md @@ -16,16 +16,16 @@ Read/compute Magnetic Field X component of the vector (1st component) by calling | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute Magnetic Field X component of the vector (1st component) by calling | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field_Y.md index c1ae352dbd..53a8f8b495 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field_Y.md @@ -16,16 +16,16 @@ Read/compute Magnetic Field Y component of the vector (2nd component) by calling | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute Magnetic Field Y component of the vector (2nd component) by calling | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field_Z.md index 6fcc7e0e42..2ef6f5f08a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_field_Z.md @@ -16,16 +16,16 @@ Read/compute Magnetic Field Z component of the vector (3rd component) by calling | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute Magnetic Field Z component of the vector (3rd component) by calling | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density.md index 3cd71de836..5bca5ab178 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density_X.md index 984ccbd911..2357f31a4b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density_X.md @@ -16,16 +16,16 @@ Read/compute Magnetic Flux Density X component of the vector (1st component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute Magnetic Flux Density X component of the vector (1st component) by | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density_Y.md index 285969e7bc..ec767781f0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density_Y.md @@ -16,16 +16,16 @@ Read/compute Magnetic Flux Density Y component of the vector (2nd component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute Magnetic Flux Density Y component of the vector (2nd component) by | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density_Z.md index 8e4723aef9..5409e5e811 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_flux_density_Z.md @@ -16,16 +16,16 @@ Read/compute Magnetic Flux Density Z component of the vector (3rd component) by | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -37,9 +37,9 @@ Read/compute Magnetic Flux Density Z component of the vector (3rd component) by | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_scalar_potential.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_scalar_potential.md index 586bfb08ef..4ec6a6ae79 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_scalar_potential.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_scalar_potential.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -39,9 +39,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_vector_potential.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_vector_potential.md index c3ac0d3e43..61e2fbe539 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_vector_potential.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/magnetic_vector_potential.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -39,9 +39,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.global_to_nodal.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.global_to_nodal.md index 1717a90637..e98ab1e8b6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.global_to_nodal.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.global_to_nodal.md @@ -29,7 +29,7 @@ Rotate results from global coordinate system to local coordinate system. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.pres_to_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.pres_to_field.md index 6174fbb56d..012576a015 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.pres_to_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.pres_to_field.md @@ -16,8 +16,8 @@ Read the presol generated file from mapdl. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| filepath |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | filepath | -| Pin 1| columns_to_read |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | columns_to_read | +| Pin 0
Required| filepath |[`string`](../../core-concepts/dpf-types.md#standard-types) | filepath | +| Pin 1| columns_to_read |[`int32`](../../core-concepts/dpf-types.md#standard-types) | columns_to_read | ## Outputs @@ -29,7 +29,7 @@ Read the presol generated file from mapdl. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.prns_to_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.prns_to_field.md index 93a44b054d..e588c26c71 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.prns_to_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.prns_to_field.md @@ -16,8 +16,8 @@ Read the presol of nodal field generated file from mapdl. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| filepath |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | filepath | -| Pin 1| columns_to_read |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | columns_to_read | +| Pin 0
Required| filepath |[`string`](../../core-concepts/dpf-types.md#standard-types) | filepath | +| Pin 1| columns_to_read |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | columns_to_read | ## Outputs @@ -29,7 +29,7 @@ Read the presol of nodal field generated file from mapdl. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.run.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.run.md index c1b5b5e8a6..d814aae8b3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.run.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl.run.md @@ -16,26 +16,26 @@ Solve in mapdl a dat/inp file and returns a datasources with the rst file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| mapdl_exe_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 1| working_dir |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 2| number_of_processes |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Set the number of MPI processes used for resolution (default is 2) | -| Pin 3| number_of_threads |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Set the number of threads used for resolution (default is 1) | +| Pin 0| mapdl_exe_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1| working_dir |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| number_of_processes |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Set the number of MPI processes used for resolution (default is 2) | +| Pin 3| number_of_threads |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Set the number of threads used for resolution (default is 1) | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | data sources containing the input file. | -| Pin 5| server_mode |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | used when a user includes commands in the input file allowing to launch DPF server inside MAPDL to interact with MAPDL using DPF client API | +| Pin 5| server_mode |[`bool`](../../core-concepts/dpf-types.md#standard-types) | used when a user includes commands in the input file allowing to launch DPF server inside MAPDL to interact with MAPDL using DPF client API | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| | **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | returns the data source if the server_mode pin is not set to yes | -| **Pin 1**| ip |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | returns the Ip if the server_mode pin is set to yes | -| **Pin 2**| port |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | returns a port when the server mode pin is set to yes | +| **Pin 1**| ip |[`string`](../../core-concepts/dpf-types.md#standard-types) | returns the Ip if the server_mode pin is set to yes | +| **Pin 2**| port |[`string`](../../core-concepts/dpf-types.md#standard-types) | returns a port when the server mode pin is set to yes | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_material_properties.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_material_properties.md index 62b6373fb9..d9b450ca33 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_material_properties.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_material_properties.md @@ -16,7 +16,7 @@ Read the values of the properties of a material for a given materials property f | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| properties_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0
Required| properties_name |[`string`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 1
Required| materials |[`property_field`](../../core-concepts/dpf-types.md#property-field) | Property field that contains a material id per element. | | Pin 3
Required| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | @@ -31,7 +31,7 @@ Read the values of the properties of a material for a given materials property f | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_section.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_section.md index 32b70891c5..2020e24b96 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_section.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_section.md @@ -16,12 +16,12 @@ Read the values of the section properties for a given section property field (pr | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| properties_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0
Required| properties_name |[`string`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 1| section |[`property_field`](../../core-concepts/dpf-types.md#property-field) | Property field that contains a section id per element.(optional) | | Pin 3
Required| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | -| Pin 5| layer_property |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Property requested is layered. Default = False. | -| Pin 6| layers_requested |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Array with layers requested for the section. Default = AllLayers. | +| Pin 5| layer_property |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Property requested is layered. Default = False. | +| Pin 6| layers_requested |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Array with layers requested for the section. Default = AllLayers. | ## Outputs @@ -34,7 +34,7 @@ Read the values of the section properties for a given section property field (pr | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_split_on_facet_indices.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_split_on_facet_indices.md index 876d37b271..08f0ebe229 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_split_on_facet_indices.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_split_on_facet_indices.md @@ -33,7 +33,7 @@ Splits each Field in a FieldsContainer defined on the skin elements of a mesh ac | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md index 0eda88e9b2..780920d96b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md @@ -29,7 +29,7 @@ This will retain the already existing labels from the input FC and will change t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mass_flow_rate.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mass_flow_rate.md index 3f7aed1d9f..a3986f8ade 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mass_flow_rate.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mass_flow_rate.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mass_fraction.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mass_fraction.md index 40ef4bd3ad..bc26fb42c5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mass_fraction.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mass_fraction.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/material_property_of_element.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/material_property_of_element.md index 66701c1236..e454781114 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/material_property_of_element.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/material_property_of_element.md @@ -34,7 +34,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mean_static_pressure.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mean_static_pressure.md index 93d9bbbd3f..1fde6d2d68 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mean_static_pressure.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mean_static_pressure.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mean_temperature.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mean_temperature.md index 189ccdd3e5..b7eb9bf2ef 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mean_temperature.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mean_temperature.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/mean_velocity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/mean_velocity.md index 7a7b03a6f7..e82979d70d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/mean_velocity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/mean_velocity.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/members_in_bending_not_certified.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/members_in_bending_not_certified.md index febd9b396b..400af0665d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/members_in_bending_not_certified.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/members_in_bending_not_certified.md @@ -16,12 +16,12 @@ This operator is a non-certified example of buckling resistance verification for | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 1
Required| field_yield_strength |[`field`](../../core-concepts/dpf-types.md#field) | This pin contains field of beam's Yield Strength defined by the user. | -| Pin 2
Required| class_cross_section |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Selection for a cross-section. True: Class 1 or 2 cross-sections. False: Class 3 cross section. If the user defines the cross section as class 1 or 2, the section modulus would be plastic section modulus. If it's class 3- cross section,the section modulus would be elastic section modulus | +| Pin 2
Required| class_cross_section |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Selection for a cross-section. True: Class 1 or 2 cross-sections. False: Class 3 cross section. If the user defines the cross section as class 1 or 2, the section modulus would be plastic section modulus. If it's class 3- cross section,the section modulus would be elastic section modulus | | Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set. | -| Pin 6
Required| partial_factor |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | partial safety factor for resistance of members to instability assessed by member checks. Default value: 1. | +| Pin 6
Required| partial_factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | partial safety factor for resistance of members to instability assessed by member checks. Default value: 1. | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh containing beam's properties defined by user | | Pin 8
Required| bending_moment_y |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of bending moment on axis y defined by user | | Pin 9
Required| bending_moment_z |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of bending moment on axis z defined by user | @@ -37,7 +37,7 @@ This operator is a non-certified example of buckling resistance verification for | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/members_in_compression_not_certified.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/members_in_compression_not_certified.md index 94921f68f5..62d3892f15 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/members_in_compression_not_certified.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/members_in_compression_not_certified.md @@ -16,16 +16,16 @@ This operator is a non-certified example of buckling resistance verification for | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq set ids (use ints or scoping) | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | time/freq set ids (use ints or scoping) | | Pin 1
Required| field_yield_strength |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | This pin contains file csv or field of beam's Yield Strength. | | Pin 2
Required| field_end_condition |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | This pin contains file csv or field of beam's end condition defined by the user. If no input at this pin found, it would take end condition's value of all beams as 1. | | Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set. | -| Pin 5
Required| manufacture |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Manufacturing processus:hot finished if TRUE or cold formed if FALSE. Default value : hot finished. | -| Pin 6
Required| partial_factor |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | partial safety factor for resistance of members to instability assessed by member checks. Default value: 1. | +| Pin 5
Required| manufacture |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Manufacturing processus:hot finished if TRUE or cold formed if FALSE. Default value : hot finished. | +| Pin 6
Required| partial_factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | partial safety factor for resistance of members to instability assessed by member checks. Default value: 1. | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh containing beam's properties defined by user | | Pin 8
Required| axial_force |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of axial force defined by user | -| Pin 12
Required| fabrication_type |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If there is beam I in the structure, please define its fabrication type. True: Rolled section, False: Welded section | +| Pin 12
Required| fabrication_type |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If there is beam I in the structure, please define its fabrication type. True: Rolled section, False: Welded section | ## Outputs @@ -38,7 +38,7 @@ This operator is a non-certified example of buckling resistance verification for | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/members_in_linear_compression_bending_not_certified.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/members_in_linear_compression_bending_not_certified.md index adefdc289b..9dae9584b8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/members_in_linear_compression_bending_not_certified.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/members_in_linear_compression_bending_not_certified.md @@ -16,19 +16,19 @@ This operator is a non-certified example of buckling resistance verification for | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 1
Required| field_yield_strength |[`field`](../../core-concepts/dpf-types.md#field) | This pin contains field of beam's Yield Strength defined by the user. | | Pin 2| field_end_condition |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | This pin contains file csv or field of beam's end condition defined by the user. If no input at this pin found, it would take end conditions value of all beams as 1 | | Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set. | -| Pin 5| manufacture |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Manufacturing processus:hot finished if TRUE or cold formed if FALSE. Default value : hot finished. | -| Pin 6| partial_factor |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | partial factor for resistance of members to instability assessed by member checks. Default value: 1.0 | +| Pin 5| manufacture |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Manufacturing processus:hot finished if TRUE or cold formed if FALSE. Default value : hot finished. | +| Pin 6| partial_factor |[`double`](../../core-concepts/dpf-types.md#standard-types) | partial factor for resistance of members to instability assessed by member checks. Default value: 1.0 | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh containing beam's properties defined by user | | Pin 8
Required| bending_moment_y |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of bending moment on axis y defined by user | | Pin 9
Required| bending_moment_z |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of bending moment on axis z defined by user | | Pin 10
Required| axial_force |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container of axial force defined by user | -| Pin 11
Required| class_cross_section |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Selection for a cross-section. True: Class 1 or 2 cross-sections. False: Class 3 cross section. If the user defines the cross section as class 1 or 2, the section modulus would be plastic section modulus. If it's class 3- cross section,the section modulus would be elastic section modulus | -| Pin 12| fabrication_type |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Selection of fabrication's type if there are beams I in the structure. TRUE: Rolled Section, False: Welded Section. Default: Rolled Section. | +| Pin 11
Required| class_cross_section |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Selection for a cross-section. True: Class 1 or 2 cross-sections. False: Class 3 cross section. If the user defines the cross section as class 1 or 2, the section modulus would be plastic section modulus. If it's class 3- cross section,the section modulus would be elastic section modulus | +| Pin 12| fabrication_type |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Selection of fabrication's type if there are beams I in the structure. TRUE: Rolled Section, False: Welded Section. Default: Rolled Section. | ## Outputs @@ -40,7 +40,7 @@ This operator is a non-certified example of buckling resistance verification for | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/migrate_to_h5dpf.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/migrate_to_h5dpf.md index e9a260a425..56a9c541b7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/migrate_to_h5dpf.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/migrate_to_h5dpf.md @@ -16,12 +16,12 @@ Read mesh properties from the results files contained in the streams or data sou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -5| dataset_size_compression_threshold |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Integer value that defines the minimum dataset size (in bytes) to use h5 native compression Applicable for arrays of floats, doubles and integers. | -| Pin -2| h5_native_compression |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Integer value / DataTree that defines the h5 native compression used For Integer Input {0: No Compression (default); 1-9: GZIP Compression : 9 provides maximum compression but at the slowest speed.}For DataTree Input {type: None / GZIP / ZSTD; level: GZIP (1-9) / ZSTD (1-20); num_threads: ZSTD (>0)} | -| Pin -1| export_floats |[`bool`](../../core-concepts/dpf-types.md#standard-types}}), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Converts double to float to reduce file size (default is true).If False, nodal results are exported as double precision and elemental results as single precision. | -| Pin 0
Required| filename |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | filename of the migrated file | -| Pin 1| comma_separated_list_of_results |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | list of results (source operator names) separated by semicolons that will be stored. (Example: U;S;EPEL). If empty, all available results will be converted. | -| Pin 2| all_time_sets |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Deprecated. Please use filtering workflows instead to select time scoping. Default is false. | +| Pin -5| dataset_size_compression_threshold |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Integer value that defines the minimum dataset size (in bytes) to use h5 native compression Applicable for arrays of floats, doubles and integers. | +| Pin -2| h5_native_compression |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Integer value / DataTree that defines the h5 native compression used For Integer Input {0: No Compression (default); 1-9: GZIP Compression : 9 provides maximum compression but at the slowest speed.}For DataTree Input {type: None / GZIP / ZSTD; level: GZIP (1-9) / ZSTD (1-20); num_threads: ZSTD (>0)} | +| Pin -1| export_floats |[`bool`](../../core-concepts/dpf-types.md#standard-types), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | Converts double to float to reduce file size (default is true).If False, nodal results are exported as double precision and elemental results as single precision. | +| Pin 0
Required| filename |[`string`](../../core-concepts/dpf-types.md#standard-types) | filename of the migrated file | +| Pin 1| comma_separated_list_of_results |[`string`](../../core-concepts/dpf-types.md#standard-types) | list of results (source operator names) separated by semicolons that will be stored. (Example: U;S;EPEL). If empty, all available results will be converted. | +| Pin 2| all_time_sets |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Deprecated. Please use filtering workflows instead to select time scoping. Default is false. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | streams (result file container) (optional) | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | if the stream is null then we need to get the file path from the data sources | | Pin 6| compression_workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | BETA Option: Applies input compression workflow. | @@ -37,7 +37,7 @@ Read mesh properties from the results files contained in the streams or data sou | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/modal_basis.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/modal_basis.md index b90a1c0d97..ebf35b9876 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/modal_basis.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/modal_basis.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -39,9 +39,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/nmisc.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/nmisc.md index e8e951be75..1550a37133 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/nmisc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/nmisc.md @@ -22,19 +22,19 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 10| item_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Index of requested item. | -| Pin 11| num_components |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Number of components for the requested item. | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 10| item_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Index of requested item. | +| Pin 11| num_components |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of components for the requested item. | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs @@ -46,9 +46,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/nodal_force.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/nodal_force.md index 601d91d3b9..992c9a325a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/nodal_force.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/nodal_force.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/nodal_moment.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/nodal_moment.md index 6e94620892..988d070c97 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/nodal_moment.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/nodal_moment.md @@ -16,12 +16,12 @@ Read/compute nodal moment by calling the readers defined by the datasources. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute nodal moment by calling the readers defined by the datasources. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/nodal_to_global.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/nodal_to_global.md index 22fbff5495..4f84e9f67f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/nodal_to_global.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/nodal_to_global.md @@ -29,7 +29,7 @@ Rotates nodal elemental results to global coordinate system | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/normal_contact_force.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/normal_contact_force.md index 24f3a2d799..2beaafe124 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/normal_contact_force.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/normal_contact_force.md @@ -16,12 +16,12 @@ Read/compute normal contact force by calling the readers defined by the datasour | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute normal contact force by calling the readers defined by the datasour | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/normal_contact_moment.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/normal_contact_moment.md index 84b63339cb..4838de2b42 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/normal_contact_moment.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/normal_contact_moment.md @@ -16,12 +16,12 @@ Read/compute normal contact moment by calling the readers defined by the datasou | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute normal contact moment by calling the readers defined by the datasou | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/num_surface_status_changes.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/num_surface_status_changes.md index 6ef9cbba42..6649234857 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/num_surface_status_changes.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/num_surface_status_changes.md @@ -22,21 +22,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -48,9 +48,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/omega.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/omega.md index 17679e2186..251eddc130 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/omega.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/omega.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_added_mass.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_added_mass.md index 9b26869202..aa57bb7311 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_added_mass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_added_mass.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_eroded_internal_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_eroded_internal_energy.md index dd08a31c51..0ed340271a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_eroded_internal_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_eroded_internal_energy.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_eroded_kinetic_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_eroded_kinetic_energy.md index 274707c011..25bc5905c0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_eroded_kinetic_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_eroded_kinetic_energy.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_hourglass_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_hourglass_energy.md index 6611739c74..b189b2b6fc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_hourglass_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_hourglass_energy.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_internal_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_internal_energy.md index d9006b440a..ecbfc0e49d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_internal_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_internal_energy.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_kinetic_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_kinetic_energy.md index 7065f842c9..762a38fe86 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_kinetic_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_kinetic_energy.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_momentum.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_momentum.md index edc03690d0..f5ded67da7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_momentum.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_momentum.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_rigid_body_velocity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_rigid_body_velocity.md index 44ad98d90d..80de968d62 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/part_rigid_body_velocity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/part_rigid_body_velocity.md @@ -25,7 +25,7 @@ This operator supports the following file types (result keys), listed by namespa | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 6| entity_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | entity (part for matsum, interface for rcforc) where the result will be scoped | -| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | +| Pin 50| unit_system |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), class dataProcessing::unit::CUnitSystem | Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance | ## Outputs @@ -37,7 +37,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_state_variable.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_state_variable.md index 1a86d76843..dbf8ac9046 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_state_variable.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_state_variable.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain.md index 205c29b003..c874529f9d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_X.md index cab57024d3..1fb1a47fbc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_X.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_XY.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_XY.md index 245015e067..f062d69c99 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_XY.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_XY.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_XZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_XZ.md index 3cb17b1215..9b5649972b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_XZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_XZ.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_Y.md index 691d1c1fc3..f80ba7546d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_Y.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_YZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_YZ.md index 40bfea8d11..c698a1b14f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_YZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_YZ.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_Z.md index a2aeab94b4..f11454802b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_Z.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_energy_density.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_energy_density.md index da973ff3e4..eafdb35a82 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_energy_density.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_energy_density.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_eqv.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_eqv.md index ce0884c33a..28114e1094 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_eqv.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_eqv.md @@ -23,17 +23,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -45,9 +45,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_intensity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_intensity.md index 052fed0d3a..b540eea152 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_intensity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_intensity.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_max_shear.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_max_shear.md index 1330cc36b3..87233bd8d2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_max_shear.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_max_shear.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_principal_1.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_principal_1.md index 94dda7635d..a297e5652d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_principal_1.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_principal_1.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_principal_2.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_principal_2.md index dcde05caf7..6e1de5c4f1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_principal_2.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_principal_2.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_principal_3.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_principal_3.md index ed0663a125..8ded7c2dc3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_principal_3.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_principal_3.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md index 6c6e5288c6..6c21e1bbab 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md @@ -30,7 +30,7 @@ read Euler angles on elements from the result file and rotate the fields in the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/poynting_vector.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/poynting_vector.md index c1b1e96b3c..37809d3044 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/poynting_vector.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/poynting_vector.md @@ -21,7 +21,7 @@ Compute the Poynting Vector | Pin 2
Required| fields_containerC |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 3
Required| fields_containerD |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 4| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | the mesh region in this pin have to be boundary or skin mesh | -| Pin 5| int32 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | load step number, if it's specified, the Poynting Vector is computed only on the substeps of this step | +| Pin 5| int32 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | load step number, if it's specified, the Poynting Vector is computed only on the substeps of this step | ## Outputs @@ -33,7 +33,7 @@ Compute the Poynting Vector | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/poynting_vector_surface.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/poynting_vector_surface.md index d5c498d93d..8b3f9225cf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/poynting_vector_surface.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/poynting_vector_surface.md @@ -21,7 +21,7 @@ Compute the Poynting Vector surface integral | Pin 2
Required| fields_containerC |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 3
Required| fields_containerD |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 4| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | the mesh region in this pin have to be boundary or skin mesh | -| Pin 5| int32 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | load step number, if it's specified, the Poynting Vector is computed only on the substeps of this step | +| Pin 5| int32 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | load step number, if it's specified, the Poynting Vector is computed only on the substeps of this step | ## Outputs @@ -33,7 +33,7 @@ Compute the Poynting Vector surface integral | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/pressure.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/pressure.md index 789f67c78a..bea3db8a3e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/pressure.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/pressure.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -39,9 +39,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/pretension.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/pretension.md index 10475aabb2..4c7ea7d816 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/pretension.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/pretension.md @@ -22,10 +22,10 @@ Reads the pretension adjustment and tension force. Rotation is not allowed for t | Pin 3
Required| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), [`stream`](../../core-concepts/dpf-types.md#stream) | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs @@ -38,7 +38,7 @@ Reads the pretension adjustment and tension force. Rotation is not allowed for t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/raw_displacement.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/raw_displacement.md index 95a9247b5a..0b26bfcdfe 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/raw_displacement.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/raw_displacement.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/raw_reaction_force.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/raw_reaction_force.md index 14cb6f7c7d..45fb9d6544 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/raw_reaction_force.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/raw_reaction_force.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -39,9 +39,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force.md index a8a3b7b837..ced2e2ebeb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force_X.md index deee3670f2..6520c24a46 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force_X.md @@ -21,14 +21,14 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force_Y.md index d2cecfbe51..55ebf7bb16 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force_Y.md @@ -21,14 +21,14 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force_Z.md index dbde783e2f..cacc70b175 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/reaction_force_Z.md @@ -21,14 +21,14 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/read_cms_rbd_file.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/read_cms_rbd_file.md index 5f3ef34677..4ca1dfe5cd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/read_cms_rbd_file.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/read_cms_rbd_file.md @@ -16,7 +16,7 @@ Read the invariant terms and the model data from a cms_rbd file | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| in_cms_rbd_file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | file name with cms_rbd extension where to read the input cms_rbd file. | +| Pin 0
Required| in_cms_rbd_file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | file name with cms_rbd extension where to read the input cms_rbd file. | ## Outputs @@ -26,31 +26,31 @@ Read the invariant terms and the model data from a cms_rbd file | **Pin 1**| center_of_mass |[`field`](../../core-concepts/dpf-types.md#field) | center of mass of the body | | **Pin 2**| inertia_relief |[`field`](../../core-concepts/dpf-types.md#field) | inertia matrix | | **Pin 3**| model_size |[`property_field`](../../core-concepts/dpf-types.md#property-field) | | -| **Pin 4**| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 5**| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | translational and rotational shape functions | +| **Pin 4**| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 5**| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | | **Pin 6**| k_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | **Pin 7**| mass_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | **Pin 8**| c_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | **Pin 9**| rhs |[`field`](../../core-concepts/dpf-types.md#field) | | -| **Pin 10**| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 11**| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 12**| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 13**| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 14**| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 15**| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 16**| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 17**| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 18**| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 19**| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 20**| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 21**| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 22**| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 10**| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 11**| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 12**| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 13**| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 14**| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 15**| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 16**| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 17**| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 18**| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 19**| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 20**| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 21**| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 22**| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/recombine_harmonic_indeces_cyclic.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/recombine_harmonic_indeces_cyclic.md index 27a8700bcb..63de2fc8c3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/recombine_harmonic_indeces_cyclic.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/recombine_harmonic_indeces_cyclic.md @@ -28,11 +28,11 @@ Add the fields corresponding to different load steps with the same frequencies t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | -| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | -| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **use_cache** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. | +| **work_by_index** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/remove_rigid_body_motion.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/remove_rigid_body_motion.md index 8c43eba1d5..7a3ec9d058 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/remove_rigid_body_motion.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/remove_rigid_body_motion.md @@ -17,7 +17,7 @@ Removes rigid body mode from a total displacement field by minimization. Use a r | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| reference_node_id |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Id of the reference entity (node). | +| Pin 1| reference_node_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Id of the reference entity (node). | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | default is the mesh in the support | ## Outputs @@ -33,7 +33,7 @@ Removes rigid body mode from a total displacement field by minimization. Use a r | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/remove_rigid_body_motion_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/remove_rigid_body_motion_fc.md index c36c7c7e55..3183bae31e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/remove_rigid_body_motion_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/remove_rigid_body_motion_fc.md @@ -17,7 +17,7 @@ Removes rigid body mode from a total displacement field by minimization. Use a r | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | field or fields container with only one field is expected | -| Pin 1| reference_node_id |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Id of the reference entity (node). | +| Pin 1| reference_node_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Id of the reference entity (node). | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | default is the mesh in the support | ## Outputs @@ -33,7 +33,7 @@ Removes rigid body mode from a total displacement field by minimization. Use a r | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/result_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/result_provider.md index 215a67c9bb..9fcf547d44 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/result_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/result_provider.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | | Pin 60
Required| result_name | | Specifies the scripting name of the raw/internal Name of the result to extract from the file | | Pin 64| result_scripting_name | | Specifies the scripting name of the result to extract;see ResultInfo for details. Use either "result name" or "result scripting name" with their appropriate pin, but not both. | @@ -41,9 +41,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/rigid_transformation.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/rigid_transformation.md index 3319b2679b..00f7e15277 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/rigid_transformation.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/rigid_transformation.md @@ -34,7 +34,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/rigid_transformation_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/rigid_transformation_provider.md index 62b9087c16..dfce6a8aea 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/rigid_transformation_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/rigid_transformation_provider.md @@ -29,7 +29,7 @@ Extracts rigid body transformation from dsub file. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/rms_static_pressure.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/rms_static_pressure.md index 9627718c8c..13d5db5c06 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/rms_static_pressure.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/rms_static_pressure.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/rms_temperature.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/rms_temperature.md index 4c4a39ebbe..6edc7c82a4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/rms_temperature.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/rms_temperature.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/rms_velocity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/rms_velocity.md index 326fbc6088..2af13c5be5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/rms_velocity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/rms_velocity.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/rom_data_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/rom_data_provider.md index 85848a127e..cc06baa107 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/rom_data_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/rom_data_provider.md @@ -16,7 +16,7 @@ Set the required data for the invariant terms computation (reduced matrices, lum | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| rom_type |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If this pin is set to true, customized rom data must be given | +| Pin 0
Required| rom_type |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If this pin is set to true, customized rom data must be given | | Pin 1
Required| reduced_stiff_matrix |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced Stiffness matrix | | Pin 2
Required| reduced_damping_matrix |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced Mass matrix | | Pin 3
Required| reduced_mass_matrix |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the reduced Damp matrix | @@ -35,16 +35,16 @@ Set the required data for the invariant terms computation (reduced matrices, lum | **Pin 3**| model_data |[`property_field`](../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | | **Pin 4**| center_of_mass |[`property_field`](../../core-concepts/dpf-types.md#property-field) | | | **Pin 5**| inertia_relief |[`field`](../../core-concepts/dpf-types.md#field) | inertia matrix | -| **Pin 6**| model_size |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | size of the model | -| **Pin 7**| field_coordinates_and_euler_angles |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | coordinates and euler angles of all nodes | -| **Pin 8**| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | ids of master nodes | +| **Pin 6**| model_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | size of the model | +| **Pin 7**| field_coordinates_and_euler_angles |[`double`](../../core-concepts/dpf-types.md#standard-types) | coordinates and euler angles of all nodes | +| **Pin 8**| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types) | ids of master nodes | | **Pin 9**| meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | expanded meshed region. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/smisc.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/smisc.md index 3c6c678a8c..2686d12f7d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/smisc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/smisc.md @@ -22,19 +22,19 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 10| item_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Index of requested item. | -| Pin 11| num_components |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Number of components for the requested item. | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 10| item_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Index of requested item. | +| Pin 11| num_components |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of components for the requested item. | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs @@ -46,9 +46,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/specific_heat.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/specific_heat.md index 177ab8a39f..c985d049cb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/specific_heat.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/specific_heat.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/spectrum_data.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/spectrum_data.md index 94bac2ed92..fa7adb3b39 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/spectrum_data.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/spectrum_data.md @@ -39,9 +39,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/state_variable.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/state_variable.md index 77ebd0ce3b..40f5f69e46 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/state_variable.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/state_variable.md @@ -22,18 +22,18 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 10| item_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Index of requested item. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 10| item_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Index of requested item. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -45,9 +45,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/static_pressure.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/static_pressure.md index f4965cde91..a58525185a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/static_pressure.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/static_pressure.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stiffness_matrix_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stiffness_matrix_energy.md index 2a4e0627a4..63551c4d1e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stiffness_matrix_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stiffness_matrix_energy.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/strain_eqv_as_mechanical.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/strain_eqv_as_mechanical.md index c2d611a826..27a116860a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/strain_eqv_as_mechanical.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/strain_eqv_as_mechanical.md @@ -16,15 +16,15 @@ Computes the equivalent (Von Mises) elastic strains and averages it to the nodes | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the results file. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | average the elemental nodal result to the requested location (default is nodal). | -| Pin 13| poisson_ratio |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}) | Poisson ratio to be used in equivalent strain calculation. | -| Pin 14| read_cyclic |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, cyclic expansion is done. If false, it's ignored. | -| Pin 200| average_across_bodies |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | average the elemental nodal result to the requested location (default is nodal). | +| Pin 13| poisson_ratio |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | Poisson ratio to be used in equivalent strain calculation. | +| Pin 14| read_cyclic |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, cyclic expansion is done. If false, it's ignored. | +| Pin 200| average_across_bodies |[`bool`](../../core-concepts/dpf-types.md#standard-types) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | ## Outputs @@ -37,7 +37,7 @@ Computes the equivalent (Von Mises) elastic strains and averages it to the nodes | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/strain_eqv_as_mechanical_workflow.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/strain_eqv_as_mechanical_workflow.md index f800a56f20..5faf4d983e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/strain_eqv_as_mechanical_workflow.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/strain_eqv_as_mechanical_workflow.md @@ -16,14 +16,14 @@ Generates a workflow that computes the equivalent (Von Mises) elastic strains an | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the results file. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | average the elemental nodal result to the requested location (default is nodal). | -| Pin 14| read_cyclic |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, cyclic expansion is done. If false, it's ignored.. | -| Pin 200| average_across_bodies |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | average the elemental nodal result to the requested location (default is nodal). | +| Pin 14| read_cyclic |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, cyclic expansion is done. If false, it's ignored.. | +| Pin 200| average_across_bodies |[`bool`](../../core-concepts/dpf-types.md#standard-types) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | ## Outputs @@ -35,7 +35,7 @@ Generates a workflow that computes the equivalent (Von Mises) elastic strains an | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress.md index 7d1c5acd6c..4df510afbb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress.md @@ -23,21 +23,21 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -49,9 +49,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_X.md index d801196e04..aae941d76a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_X.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_XY.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_XY.md index 0cd08106d3..d06b7b124c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_XY.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_XY.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_XZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_XZ.md index f1a704ebc1..62beef17ea 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_XZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_XZ.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_Y.md index 1678d5f2a0..63ef8f0eb3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_Y.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_YZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_YZ.md index 7277067cca..45b9aadf4f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_YZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_YZ.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_Z.md index 5dc7df2f3f..4f320cd033 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_Z.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_eqv_as_mechanical.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_eqv_as_mechanical.md index 02117f3583..0e95d0810e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_eqv_as_mechanical.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_eqv_as_mechanical.md @@ -16,14 +16,14 @@ Computes the equivalent (Von Mises) stresses and averages it to the nodes (by de | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the results file. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | average the elemental nodal result to the requested location (default is nodal). | -| Pin 14| read_cyclic |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, cyclic expansion is done. If false, it's ignored.. | -| Pin 200| average_across_bodies |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | average the elemental nodal result to the requested location (default is nodal). | +| Pin 14| read_cyclic |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, cyclic expansion is done. If false, it's ignored.. | +| Pin 200| average_across_bodies |[`bool`](../../core-concepts/dpf-types.md#standard-types) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | ## Outputs @@ -36,7 +36,7 @@ Computes the equivalent (Von Mises) stresses and averages it to the nodes (by de | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_eqv_as_mechanical_workflow.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_eqv_as_mechanical_workflow.md index 17df5e0f71..52c8554e6b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_eqv_as_mechanical_workflow.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_eqv_as_mechanical_workflow.md @@ -16,14 +16,14 @@ Generates a workflow that computes the equivalent (Von Mises) stresses and avera | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | nodes or elements scoping required in output. | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data. | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the results file. | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | average the elemental nodal result to the requested location (default is nodal). | -| Pin 14| read_cyclic |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, cyclic expansion is done. If false, it's ignored.. | -| Pin 200| average_across_bodies |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | average the elemental nodal result to the requested location (default is nodal). | +| Pin 14| read_cyclic |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, cyclic expansion is done. If false, it's ignored.. | +| Pin 200| average_across_bodies |[`bool`](../../core-concepts/dpf-types.md#standard-types) | for multibody simulations, the stresses are averaged across bodies if true or not if false (default). | ## Outputs @@ -35,7 +35,7 @@ Generates a workflow that computes the equivalent (Von Mises) stresses and avera | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_intensity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_intensity.md index e862db8d67..911cf9ac8e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_intensity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_intensity.md @@ -22,16 +22,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_max_shear.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_max_shear.md index a7b6614d5e..253fa2df26 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_max_shear.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_max_shear.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_principal_1.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_principal_1.md index 069c5892e1..0590e6b35a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_principal_1.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_principal_1.md @@ -22,16 +22,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_principal_2.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_principal_2.md index 8a0076d4a1..f5b5b9959e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_principal_2.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_principal_2.md @@ -22,16 +22,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_principal_3.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_principal_3.md index 5cf3a3aac2..c8d541b462 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_principal_3.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_principal_3.md @@ -22,16 +22,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_ratio.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_ratio.md index 3d27cfa635..3a45a95a90 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_ratio.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_ratio.md @@ -21,17 +21,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -43,9 +43,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_rotation_by_euler_nodes.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_rotation_by_euler_nodes.md index 4d45f30754..25e6a650c4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_rotation_by_euler_nodes.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_rotation_by_euler_nodes.md @@ -30,7 +30,7 @@ read Euler angles on elements from the result file and rotate the fields in the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_von_mises.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_von_mises.md index 869318d315..49aeb83dab 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_von_mises.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/stress_von_mises.md @@ -23,16 +23,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/structural_temperature.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/structural_temperature.md index c862fe1517..4e55526041 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/structural_temperature.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/structural_temperature.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/superficial_velocity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/superficial_velocity.md index c3cd41f0da..2513a64e23 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/superficial_velocity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/superficial_velocity.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/surface_heat_rate.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/surface_heat_rate.md index e736d1dc49..91e6348ac3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/surface_heat_rate.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/surface_heat_rate.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/swelling_strains.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/swelling_strains.md index 7d7df3b294..eacc62007b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/swelling_strains.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/swelling_strains.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/tangential_contact_force.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/tangential_contact_force.md index a4b599a4f9..7a9c01ae2a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/tangential_contact_force.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/tangential_contact_force.md @@ -16,12 +16,12 @@ Read/compute tangential contact force by calling the readers defined by the data | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute tangential contact force by calling the readers defined by the data | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/tangential_contact_moment.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/tangential_contact_moment.md index 979eabe7f3..546b19482c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/tangential_contact_moment.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/tangential_contact_moment.md @@ -16,12 +16,12 @@ Read/compute tangential contact moment by calling the readers defined by the dat | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute tangential contact moment by calling the readers defined by the dat | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature.md index e6b9dbafe0..a3e8f58c1b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature.md @@ -24,18 +24,18 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -48,9 +48,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad.md index 2f3de4bbb3..7e5177976a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad_X.md index 93957c85e5..9d18eeaacf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad_X.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad_Y.md index aa4614d199..1f5c11e731 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad_Y.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad_Z.md index 1b7235c033..bce4d1f8ed 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/temperature_grad_Z.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_conductivity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_conductivity.md index a9cec245b9..b7ea95f64d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_conductivity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_conductivity.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_dissipation_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_dissipation_energy.md index 2017db9729..e282249b0c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_dissipation_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_dissipation_energy.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain.md index 1120feb094..4cc4a20d90 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_X.md index db8e64f647..6c33c198cb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_X.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_XY.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_XY.md index 6151ef93b2..639eb9e074 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_XY.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_XY.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_XZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_XZ.md index 6a6c583d76..995f782c5f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_XZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_XZ.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_Y.md index 91140e5c6d..1b04e80f8e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_Y.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_YZ.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_YZ.md index bd11185df9..dc511d0e53 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_YZ.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_YZ.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_Z.md index 5d4e81fb60..dca4528574 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_Z.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location, default is Nodal | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location, default is Nodal | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_principal_1.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_principal_1.md index 5a1e73ca54..56e89407d9 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_principal_1.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_principal_1.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_principal_2.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_principal_2.md index bf73a8e473..4c05807b28 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_principal_2.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_principal_2.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_principal_3.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_principal_3.md index 1cdd832758..dc2e9c9ee2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_principal_3.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strain_principal_3.md @@ -21,16 +21,16 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | ## Outputs @@ -42,9 +42,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strains_eqv.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strains_eqv.md index 2f0f366907..1cf10f78b4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strains_eqv.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thermal_strains_eqv.md @@ -22,17 +22,17 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | requested location Nodal, Elemental or ElementalNodal | -| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | elemental nodal beam results are read if this pin is set to true (default is false) | -| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | -| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal | +| Pin 22| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) | +| Pin 26| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided. | +| Pin 27| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer. | ## Outputs @@ -44,9 +44,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/thickness.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/thickness.md index c6ea4bb5d3..ffac731a28 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/thickness.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/thickness.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/torque.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/torque.md index c34224deba..61b332bdcd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/torque.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/torque.md @@ -29,7 +29,7 @@ Compute torque of a force based on a 3D point. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/total_contact_force.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/total_contact_force.md index 6bcb20dc13..bd21503743 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/total_contact_force.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/total_contact_force.md @@ -16,12 +16,12 @@ Read/compute total contact force by calling the readers defined by the datasourc | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute total contact force by calling the readers defined by the datasourc | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/total_contact_moment.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/total_contact_moment.md index f77ff387f6..595e81bbe2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/total_contact_moment.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/total_contact_moment.md @@ -16,12 +16,12 @@ Read/compute total contact moment by calling the readers defined by the datasour | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -34,9 +34,9 @@ Read/compute total contact moment by calling the readers defined by the datasour | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/total_mass.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/total_mass.md index 6dc8709806..afcfd83a8e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/total_mass.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/total_mass.md @@ -22,13 +22,13 @@ Reads total mass from mode file. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| mass |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | the unit should be grabbed from the rst file | +| **Pin 0**| mass |[`double`](../../core-concepts/dpf-types.md#standard-types) | the unit should be grabbed from the rst file | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/total_pressure.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/total_pressure.md index 33f3550222..480c246dfe 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/total_pressure.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/total_pressure.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/total_strain.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/total_strain.md index 9bb20f5aec..326b2ccb44 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/total_strain.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/total_strain.md @@ -22,12 +22,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/total_temperature.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/total_temperature.md index c926408796..eb37480725 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/total_temperature.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/total_temperature.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/transform_invariant_terms_rbd.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/transform_invariant_terms_rbd.md index cd6ab3b29c..cda2b6ebac 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/transform_invariant_terms_rbd.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/transform_invariant_terms_rbd.md @@ -21,26 +21,26 @@ Transform invariant terms rbd based on a coordinate system (translation + rotati | Pin 2
Required| model_data |[`property_field`](../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | | Pin 3
Required| center_of_mass |[`field`](../../core-concepts/dpf-types.md#field) | center of mass of the body | | Pin 4
Required| inertia_relief |[`field`](../../core-concepts/dpf-types.md#field) | inertia matrix | -| Pin 5
Required| model_size |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | size of the diagonal box containing the body | -| Pin 6
Required| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 7
Required| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | translational and rotational shape functions | +| Pin 5
Required| model_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | size of the diagonal box containing the body | +| Pin 6
Required| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 7
Required| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | | Pin 8
Required| k_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 9
Required| mass_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 10
Required| c_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 11
Required| rhs |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 12
Required| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 13
Required| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14
Required| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 15
Required| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 16
Required| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 17
Required| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 18
Required| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 19
Required| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 20
Required| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 21
Required| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 22
Required| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 23
Required| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 24
Required| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 12
Required| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 13
Required| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14
Required| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 15
Required| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 16
Required| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 17
Required| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 18
Required| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 19
Required| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 20
Required| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 21
Required| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 22
Required| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 23
Required| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 24
Required| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -50,32 +50,32 @@ Transform invariant terms rbd based on a coordinate system (translation + rotati | **Pin 1**| center_of_mass |[`field`](../../core-concepts/dpf-types.md#field) | center of mass of the body | | **Pin 2**| inertia_relief |[`field`](../../core-concepts/dpf-types.md#field) | inertia matrix | | **Pin 3**| model_size |[`property_field`](../../core-concepts/dpf-types.md#property-field) | | -| **Pin 4**| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 5**| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | translational and rotational shape functions | +| **Pin 4**| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 5**| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | | **Pin 6**| k_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | **Pin 7**| mass_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | **Pin 8**| c_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | **Pin 9**| rhs |[`field`](../../core-concepts/dpf-types.md#field) | | -| **Pin 10**| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 11**| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 12**| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 13**| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 14**| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 15**| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 16**| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 17**| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 18**| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 19**| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 20**| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 21**| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| **Pin 22**| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 10**| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 11**| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 12**| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 13**| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 14**| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 15**| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 16**| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 17**| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 18**| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 19**| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 20**| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 21**| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| **Pin 22**| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | The output is written over the input to save memory if this config is set to true. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **inplace** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | The output is written over the input to save memory if this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/transient_rayleigh_integration.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/transient_rayleigh_integration.md index 48daba91b1..527e4ee6e5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/transient_rayleigh_integration.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/transient_rayleigh_integration.md @@ -18,11 +18,11 @@ Computes the transient Rayleigh integral |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | the input field container expects acceleration fields | | Pin 1
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | The meshes region in this pin has to be boundary or skin mesh. This is the source meshes. | -| Pin 2
Required| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Load step number (if it's specified, the Transient rayleigh integration is computed only on the substeps of this step) or time scoping | +| Pin 2
Required| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Load step number (if it's specified, the Transient rayleigh integration is computed only on the substeps of this step) or time scoping | | Pin 3
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | The field represents the coordinates of the observation position. It should be specified if not observation mesh is provided. | | Pin 4
Required| observation_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | This is the observation mesh region | -| Pin 5
Required| mass_density |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Mass density (if it's not specified, default value of the air is applied). | -| Pin 6
Required| speed_of_sound |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Speed of sound (if it's not specified, default value of the speed of sound in the air is applied). | +| Pin 5
Required| mass_density |[`double`](../../core-concepts/dpf-types.md#standard-types) | Mass density (if it's not specified, default value of the air is applied). | +| Pin 6
Required| speed_of_sound |[`double`](../../core-concepts/dpf-types.md#standard-types) | Speed of sound (if it's not specified, default value of the speed of sound in the air is applied). | ## Outputs @@ -34,7 +34,7 @@ Computes the transient Rayleigh integral | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/turbulent_kinetic_energy.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/turbulent_kinetic_energy.md index a4f7044f47..439eda3080 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/turbulent_kinetic_energy.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/turbulent_kinetic_energy.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/turbulent_viscosity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/turbulent_viscosity.md index 1bd004a4f5..80341a79f3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/turbulent_viscosity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/turbulent_viscosity.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity.md index 30172e57e0..0de3d48880 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity.md @@ -24,18 +24,18 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh. If cylic expansion is to be done, mesh of the base sector | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | | Pin 15| expanded_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | mesh expanded, use if cyclic expansion is to be done. | -| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | -| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 18| sectors_to_expand |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. | +| Pin 19| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -48,9 +48,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity_X.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity_X.md index 7465f64b46..cf8cb7bb03 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity_X.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity_X.md @@ -21,14 +21,14 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity_Y.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity_Y.md index a4e847a78c..5feb9b014b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity_Y.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity_Y.md @@ -21,14 +21,14 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity_Z.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity_Z.md index 114f0c407a..b07eda95c4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity_Z.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/velocity_Z.md @@ -21,14 +21,14 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 2| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true the field is rotated to global coordinate system (default true) | +| Pin 5| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | +| Pin 14| read_cyclic |enum dataProcessing::ECyclicReading, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) | ## Outputs @@ -40,9 +40,9 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/volume_fraction.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/volume_fraction.md index b4152f4270..91d32df4ba 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/volume_fraction.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/volume_fraction.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/wall_shear_stress.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/wall_shear_stress.md index b73fa5516d..139285326b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/wall_shear_stress.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/wall_shear_stress.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/workflow_energy_per_component.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/workflow_energy_per_component.md index 47462cf21c..71979e714a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/workflow_energy_per_component.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/workflow_energy_per_component.md @@ -18,9 +18,9 @@ Calculates the cumulated energy per component (Named Selection). For cyclic and |-------|-------|------------------|-------------| | Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | When the input is a scoping, it is treated as the master scoping. All named selections will intersect with it. When the input is a scopings container, named selections will not be needed. | -| Pin 2| energy_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Type of energy to be processed: (0: Strain + Kinetic energy (default), 1: Strain energy, 2: Kinetic energy, 3: All energy types) | +| Pin 2| energy_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Type of energy to be processed: (0: Strain + Kinetic energy (default), 1: Strain energy, 2: Kinetic energy, 3: All energy types) | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | -| Pin 5| named_selection |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Named Selections. Intersection of all Named Selections with the master scoping will be done. | +| Pin 5| named_selection |[`string`](../../core-concepts/dpf-types.md#standard-types) | Named Selections. Intersection of all Named Selections with the master scoping will be done. | ## Outputs @@ -39,7 +39,7 @@ Calculates the cumulated energy per component (Named Selection). For cyclic and | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/workflow_energy_per_harmonic.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/workflow_energy_per_harmonic.md index 20c1c368f8..ea0eedf7bf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/workflow_energy_per_harmonic.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/workflow_energy_per_harmonic.md @@ -18,7 +18,7 @@ Calculates the cumulated energy per harmonic in a multistage multiharmonic model |-------|-------|------------------|-------------| | Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Master scoping. All harmonics will be intersected with this scoping. | -| Pin 2| energy_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Type of energy to be processed: (0: Strain + Kinetic energy (default), 1: Strain energy, 2: Kinetic energy) | +| Pin 2| energy_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Type of energy to be processed: (0: Strain + Kinetic energy (default), 1: Strain energy, 2: Kinetic energy) | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs @@ -32,7 +32,7 @@ Calculates the cumulated energy per harmonic in a multistage multiharmonic model | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/write_cms_rbd_file.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/write_cms_rbd_file.md index c6d2ce3a76..a474a6e999 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/write_cms_rbd_file.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/write_cms_rbd_file.md @@ -19,27 +19,27 @@ Write the invariant terms and the model data in a cms_rbd file | Pin 0
Required| model_data |[`property_field`](../../core-concepts/dpf-types.md#property-field) | data describing the finite element model | | Pin 1
Required| center_of_mass |[`field`](../../core-concepts/dpf-types.md#field) | center of mass of the body | | Pin 2
Required| inertia_relief |[`field`](../../core-concepts/dpf-types.md#field) | inertia matrix | -| Pin 3
Required| model_size |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | size of the diagonal box containing the body | -| Pin 4
Required| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 5
Required| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | translational and rotational shape functions | +| Pin 3
Required| model_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | size of the diagonal box containing the body | +| Pin 4
Required| master_node_coordinates |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 5
Required| v_trsf |[`vector`](../../core-concepts/dpf-types.md#standard-types) | translational and rotational shape functions | | Pin 6
Required| k_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 7
Required| mass_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 8
Required| c_mat |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 9
Required| rhs |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 10
Required| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 11
Required| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 12
Required| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 13
Required| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14
Required| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 15
Required| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 16
Required| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 17
Required| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 18
Required| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 19
Required| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 20
Required| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 21
Required| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 22
Required| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 23
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | path with cms_rbd extension where the export occurs | +| Pin 10
Required| dn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 11
Required| dr_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 12
Required| drn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 13
Required| dn_cross_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14
Required| dnx_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 15
Required| dny_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 16
Required| dnz_y |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 17
Required| dyx_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 18
Required| dyy_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 19
Required| dyz_n |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 20
Required| dnxn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 21
Required| dnyn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 22
Required| dnzn |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 23
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | path with cms_rbd extension where the export occurs | ## Outputs @@ -51,7 +51,7 @@ Write the invariant terms and the model data in a cms_rbd file | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/write_motion_dfmf_file.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/write_motion_dfmf_file.md index 7bfbd57a47..02ed8e1127 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/write_motion_dfmf_file.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/write_motion_dfmf_file.md @@ -20,21 +20,21 @@ Write the invariant terms and the model data in a motion dfmf file | Pin 1
Required| mode_shapes |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the mode shapes, which are CST and NOR for the cms method | | Pin 2
Required| lumped_mass |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainers containing the lumped mass | | Pin 3
Required| field_coordinates |[`field`](../../core-concepts/dpf-types.md#field) | coordinates of all nodes | -| Pin 4
Required| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 5
Required| used_node_index |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 6
Required| eigenvalue |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 7
Required| translational_mode_shape |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 8
Required| rotational_mode_shape |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 9
Required| invrt_1 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 10
Required| invrt_2 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 11
Required| invrt_3 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 12
Required| invrt_4 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 13
Required| invrt_5 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 14
Required| invrt_6 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 15
Required| invrt_7 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 16
Required| invrt_8 |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 17
Required| dfmffile_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | path with motion dfmf extension where the export occurs | -| Pin 18
Required| rstfile_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 4
Required| nod |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 5
Required| used_node_index |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 6
Required| eigenvalue |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 7
Required| translational_mode_shape |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 8
Required| rotational_mode_shape |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 9
Required| invrt_1 |[`double`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 10
Required| invrt_2 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 11
Required| invrt_3 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 12
Required| invrt_4 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 13
Required| invrt_5 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 14
Required| invrt_6 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 15
Required| invrt_7 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 16
Required| invrt_8 |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 17
Required| dfmffile_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | path with motion dfmf extension where the export occurs | +| Pin 18
Required| rstfile_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -46,7 +46,7 @@ Write the invariant terms and the model data in a motion dfmf file | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/result/y_plus.md b/2025R2/dpf-framework-25-r2/operator-specifications/result/y_plus.md index 9c81cc5926..8e5c367a75 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/result/y_plus.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/result/y_plus.md @@ -21,12 +21,12 @@ This operator supports the following file types (result keys), listed by namespa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. | | Pin 1| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files | -| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | +| Pin 25| region_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). | | Pin 1000| qualifiers |[`label_space`](../../core-concepts/dpf-types.md#label-space) | (for Fluid results only) LabelSpace with combination of zone, phases or species ids | ## Outputs @@ -39,7 +39,7 @@ This operator supports the following file types (result keys), listed by namespa | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/adapt_with_scopings_container.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/adapt_with_scopings_container.md index f1dd293c61..222b082af1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/adapt_with_scopings_container.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/adapt_with_scopings_container.md @@ -29,9 +29,9 @@ Rescopes/splits a fields container to correspond to a scopings container. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/change_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/change_fc.md index 52bc3822dc..077f46a601 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/change_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/change_fc.md @@ -29,9 +29,9 @@ DEPRECATED, PLEASE USE ADAPT WITH SCOPINGS CONTAINER. Rescopes/splits a fields c | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/compute_element_centroids.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/compute_element_centroids.md index 52464e9ff8..22291525a3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/compute_element_centroids.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/compute_element_centroids.md @@ -30,8 +30,8 @@ Computes the element centroids of the mesh. It also outputs the element measure. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/connectivity_ids.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/connectivity_ids.md index 818a65b7be..57c38bd4ce 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/connectivity_ids.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/connectivity_ids.md @@ -18,7 +18,7 @@ Returns the ordered node ids corresponding to the element ids scoping in input. |-------|-------|------------------|-------------| | Pin 1
Required| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Elemental scoping | | Pin 7| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | the support of the scoping is expected if there is no mesh in input | -| Pin 10| take_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | default is true | +| Pin 10| take_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | default is true | ## Outputs @@ -31,7 +31,7 @@ Returns the ordered node ids corresponding to the element ids scoping in input. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/elemental_from_mesh.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/elemental_from_mesh.md index d2d4400e55..d30cbfa294 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/elemental_from_mesh.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/elemental_from_mesh.md @@ -28,7 +28,7 @@ Retrieves the elemental scoping of a given input mesh, which contains the elemen | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/from_mesh.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/from_mesh.md index d366b0bc69..8936e70f97 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/from_mesh.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/from_mesh.md @@ -17,7 +17,7 @@ Provides the entire mesh scoping based on the requested location | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | if nothing the operator returns the nodes scoping, possible locations are: Nodal(default) or Elemental | +| Pin 1| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | if nothing the operator returns the nodes scoping, possible locations are: Nodal(default) or Elemental | ## Outputs @@ -29,7 +29,7 @@ Provides the entire mesh scoping based on the requested location | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/intersect.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/intersect.md index bd1f824661..4c52d0ce9a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/intersect.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/intersect.md @@ -30,7 +30,7 @@ Intersect 2 scopings and return the intersection and the difference between the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/nodal_from_mesh.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/nodal_from_mesh.md index a84e544ad8..747e918cee 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/nodal_from_mesh.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/nodal_from_mesh.md @@ -28,7 +28,7 @@ Retrieves the nodal scoping of a given input mesh, which contains the node IDs. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/on_mesh_property.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/on_mesh_property.md index 5bdcc4b262..ae436ce959 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/on_mesh_property.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/on_mesh_property.md @@ -16,10 +16,10 @@ Provides a scoping on a given property name and a property number. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Nodal or Elemental location are expected | -| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | ex "apdl_element_type", "elprops", "mat", "eltype", "connectivity", "shell_elements", "solid_elements", "skin_elements", "beam_elements", "point_elements"... | -| Pin 2| property_id |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 5| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Default is 1 (inclusive is true). Only used if 'shape_values' property is requested. If inclusive is set to 1 and 'elprops' property field is available, it will select all elements that are set on the corresponding property. If inclusive is set to 0 (exclusive) and 'elprops' property field is available, it will select the elements that are only set on this property. | +| Pin 0| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Nodal or Elemental location are expected | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | ex "apdl_element_type", "elprops", "mat", "eltype", "connectivity", "shell_elements", "solid_elements", "skin_elements", "beam_elements", "point_elements"... | +| Pin 2| property_id |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 5| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Default is 1 (inclusive is true). Only used if 'shape_values' property is requested. If inclusive is set to 1 and 'elprops' property field is available, it will select all elements that are set on the corresponding property. If inclusive is set to 0 (exclusive) and 'elprops' property field is available, it will select the elements that are only set on this property. | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | ## Outputs @@ -32,7 +32,7 @@ Provides a scoping on a given property name and a property number. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/on_named_selection.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/on_named_selection.md index 2797be7ad1..a2121a196d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/on_named_selection.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/on_named_selection.md @@ -16,9 +16,9 @@ provides a scoping at a given location based on a given named selection | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 1
Required| named_selection_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | the string is expected to be in upper case | -| Pin 2| int_inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If element scoping is requested on a nodal named selection, if Inclusive == 1 then add all the elements adjacent to the nodes.If Inclusive == 0, only the elements which have all their nodes in the named selection are included | +| Pin 0
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1
Required| named_selection_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | the string is expected to be in upper case | +| Pin 2| int_inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If element scoping is requested on a nodal named selection, if Inclusive == 1 then add all the elements adjacent to the nodes.If Inclusive == 0, only the elements which have all their nodes in the named selection are included | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | @@ -32,7 +32,7 @@ provides a scoping at a given location based on a given named selection | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/on_property.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/on_property.md index d38f5a14c5..2987fd45f8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/on_property.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/on_property.md @@ -16,12 +16,12 @@ Provides a scoping at a given location based on a given property name and a prop | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Nodal or Elemental location are expected | -| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | ex "mapdl_element_type", "mapdl_element_type_id", "apdl_type_index", "mapdl_type_id", "material", "apdl_section_id", "apdl_real_id", "apdl_esys_id", "shell_axi", "volume_axi"... | -| Pin 2
Required| property_id |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Nodal or Elemental location are expected | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | ex "mapdl_element_type", "mapdl_element_type_id", "apdl_type_index", "mapdl_type_id", "material", "apdl_section_id", "apdl_real_id", "apdl_esys_id", "shell_axi", "volume_axi"... | +| Pin 2
Required| property_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | -| Pin 5| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If element scoping is requested on a nodal named selection, if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | +| Pin 5| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If element scoping is requested on a nodal named selection, if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | ## Outputs @@ -33,7 +33,7 @@ Provides a scoping at a given location based on a given property name and a prop | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/reduce_sampling.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/reduce_sampling.md index 1f02655043..6fa50b1777 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/reduce_sampling.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/reduce_sampling.md @@ -17,7 +17,7 @@ Take a scoping and remove half of it's content. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 1| denominator |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Set the number of time the scoping is reduced (default is 2). Must be integer value above 1. | +| Pin 1| denominator |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Set the number of time the scoping is reduced (default is 2). Must be integer value above 1. | ## Outputs @@ -29,7 +29,7 @@ Take a scoping and remove half of it's content. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope.md index 57fcaa9730..bbdee1ea98 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope.md @@ -17,8 +17,8 @@ Rescopes a field on the given scoping. If an ID does not exist in the original f | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | If pin 2 is used, the IDs not found in the field are added with this default value. | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | If pin 2 is used, the IDs not found in the field are added with this default value. | ## Outputs @@ -30,9 +30,9 @@ Rescopes a field on the given scoping. If an ID does not exist in the original f | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope_custom_type_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope_custom_type_field.md index fa1cdc56ee..a71b3063db 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope_custom_type_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope_custom_type_field.md @@ -17,7 +17,7 @@ Rescopes a custom type field on the given scoping. If an ID does not exist in th | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields |[`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field) | | -| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 2| default_value |[`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field) | If pin 2 is used, the IDs not found in the custom type field are added with this default value. | ## Outputs @@ -30,9 +30,9 @@ Rescopes a custom type field on the given scoping. If an ID does not exist in th | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope_fc.md index 1fd6065bad..57705de8c9 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope_fc.md @@ -17,8 +17,8 @@ Rescopes a field on the given scoping. If an ID does not exist in the original f | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | If pin 2 is used, the IDs not found in the field are added with this default value. | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| default_value |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | If pin 2 is used, the IDs not found in the field are added with this default value. | ## Outputs @@ -30,9 +30,9 @@ Rescopes a field on the given scoping. If an ID does not exist in the original f | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope_property_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope_property_field.md index e08fc14d0c..80f5da858c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope_property_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/rescope_property_field.md @@ -17,8 +17,8 @@ Rescopes a property field on the given scoping. If an ID does not exist in the o | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field) | | -| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 2| default_value |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | If pin 2 is used, the IDs not found in the property field are added with this default value. | +| Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| default_value |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | If pin 2 is used, the IDs not found in the property field are added with this default value. | ## Outputs @@ -30,9 +30,9 @@ Rescopes a property field on the given scoping. If an ID does not exist in the o | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/scoping_get_attribute.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/scoping_get_attribute.md index a0cf58ebb5..4255b09ed6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/scoping_get_attribute.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/scoping_get_attribute.md @@ -17,19 +17,19 @@ Uses the Scoping APIs to return a given attribute of the scoping in input. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Supported property names are: "ids", "location". | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "ids", "location". | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`string`](../../core-concepts/dpf-types.md#standard-types}}) | Returns a vector of int for property: "ids" and a string for property: "location". | +| **Pin 0**| property |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | Returns a vector of int for property: "ids" and a string for property: "location". | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/split_on_property_type.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/split_on_property_type.md index ffee1a7866..13815c7f72 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/split_on_property_type.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/split_on_property_type.md @@ -18,9 +18,9 @@ Splits a given scoping or the mesh scoping (nodal or elemental) on given propert |-------|-------|------------------|-------------| | Pin 1| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Scoping | | Pin 7
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | mesh region | -| Pin 9
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | location (default is elemental) | -| Pin 12| skin_case |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | set to 0: to have skin elements in their own group, 1: merge skin and solid elements, 2: merge skin and shell elements (default) | -| Pin 13| label |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | properties to apply the filtering 'mat' and/or 'elshape' (since 2025R1 it supports any property name contained in the mesh property fields) (default is 'elshape') | +| Pin 9
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | location (default is elemental) | +| Pin 12| skin_case |[`int32`](../../core-concepts/dpf-types.md#standard-types) | set to 0: to have skin elements in their own group, 1: merge skin and solid elements, 2: merge skin and shell elements (default) | +| Pin 13| label |[`string`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | properties to apply the filtering 'mat' and/or 'elshape' (since 2025R1 it supports any property name contained in the mesh property fields) (default is 'elshape') | ## Outputs @@ -32,7 +32,7 @@ Splits a given scoping or the mesh scoping (nodal or elemental) on given propert | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/transpose.md b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/transpose.md index a6f255d5dd..ef7e14d46f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/scoping/transpose.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/scoping/transpose.md @@ -18,8 +18,8 @@ Transposes the input scoping or scopings container (Elemental/Faces --> Nodal, o |-------|-------|------------------|-------------| | Pin 0
Required| mesh_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Scoping or scopings container (the input type is the output type) | | Pin 1
Required| meshed_region |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | | -| Pin 2| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | -| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Output scoping location for meshes with nodes, faces and elements. By default, elemental and faces scopings transpose to nodal, and nodal scopings transpose to elemental. | +| Pin 2| inclusive |[`int32`](../../core-concepts/dpf-types.md#standard-types) | if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included | +| Pin 9| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Output scoping location for meshes with nodes, faces and elements. By default, elemental and faces scopings transpose to nodal, and nodal scopings transpose to elemental. | ## Outputs @@ -31,7 +31,7 @@ Transposes the input scoping or scopings container (Elemental/Faces --> Nodal, o | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/csv_to_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/csv_to_field.md index 3fce043eaf..3e72eff36f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/csv_to_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/csv_to_field.md @@ -29,7 +29,7 @@ transform csv file to a field or fields container | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/data_tree_to_json.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/data_tree_to_json.md index de8c51fb6e..3ccb5bff20 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/data_tree_to_json.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/data_tree_to_json.md @@ -17,19 +17,19 @@ Writes a json file or string from a DataTree | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| data_tree |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | | -| Pin 1| path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1| path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/data_tree_to_txt.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/data_tree_to_txt.md index cde18cb3e5..388620cd92 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/data_tree_to_txt.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/data_tree_to_txt.md @@ -17,19 +17,19 @@ Writes a txt file or string from a DataTree | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| data_tree |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | | -| Pin 1| path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1| path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/deserializer.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/deserializer.md index 8647e4b830..2ed81afeba 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/deserializer.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/deserializer.md @@ -16,8 +16,8 @@ Takes a file generated by the serializer and deserializes it into DPF's entities | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1
Required| stream_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 for ASCII (default), and 1 for binary | -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | file path | +| Pin -1
Required| stream_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 for ASCII (default), and 1 for binary | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | file path | ## Outputs @@ -29,7 +29,7 @@ Takes a file generated by the serializer and deserializes it into DPF's entities | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/export_symbolic_workflow.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/export_symbolic_workflow.md index a945e4b4a4..b5d68da3f3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/export_symbolic_workflow.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/export_symbolic_workflow.md @@ -17,21 +17,21 @@ Transforms a Workflow into a symbolic Workflow and writes it to a file (if a pat | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow) | | -| Pin 1| path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 2| format |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 is ASCII format and 1 is binary, default is 0. | -| Pin 3| options |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1 copies connections with its data, 2 forwards named inputs and outputs names, 7 copies connections of named inputs and ouputs with their data. default is 7. | +| Pin 1| path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| format |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 is ASCII format and 1 is binary, default is 0. | +| Pin 3| options |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 1 copies connections with its data, 2 forwards named inputs and outputs names, 7 copies connections of named inputs and ouputs with their data. default is 7. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/field_to_csv.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/field_to_csv.md index 3cfe18098c..4e4840c09c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/field_to_csv.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/field_to_csv.md @@ -17,8 +17,8 @@ Exports a field or a fields container into a csv file | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field_or_fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | field_or_fields_container | -| Pin 1
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 2| storage_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | storage type : if matrices (without any particularity) are included in the fields container, the storage format can be chosen. 0 : flat/line format, 1 : ranked format. If 1 is chosen, the csv can not be read by "csv to field" operator anymore. Default : 0. | +| Pin 1
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| storage_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | storage type : if matrices (without any particularity) are included in the fields container, the storage format can be chosen. 0 : flat/line format, 1 : ranked format. If 1 is chosen, the csv can not be read by "csv to field" operator anymore. Default : 0. | ## Outputs @@ -29,7 +29,7 @@ Exports a field or a fields container into a csv file | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/hdf5dpf_custom_read.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/hdf5dpf_custom_read.md index f1515df0f8..79762a7002 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/hdf5dpf_custom_read.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/hdf5dpf_custom_read.md @@ -33,7 +33,7 @@ Extract a custom result from an hdf5dpf file. This operator is deprecated, pleas | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/hdf5dpf_generate_result_file.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/hdf5dpf_generate_result_file.md index 1f1eb59644..44632bdb1e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/hdf5dpf_generate_result_file.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/hdf5dpf_generate_result_file.md @@ -16,15 +16,15 @@ Generate a dpf result file from provided information. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -6| append_mode |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Experimental: Allow appending chunked data to the file. This disables fields container content deduplication. | -| Pin -5| dataset_size_compression_threshold |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Integer value that defines the minimum dataset size (in bytes) to use h5 native compression Applicable for arrays of floats, doubles and integers. | -| Pin -2| h5_native_compression |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | Integer value / DataTree that defines the h5 native compression used For Integer Input {0: No Compression (default); 1-9: GZIP Compression : 9 provides maximum compression but at the slowest speed.}For DataTree Input {type: None / GZIP / ZSTD; level: GZIP (1-9) / ZSTD (1-20); num_threads: ZSTD (>0)} | -| Pin -1| export_floats |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | converts double to float to reduce file size (default is true) | -| Pin 0
Required| filename |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | name of the output file that will be generated (utf8). | +| Pin -6| append_mode |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Experimental: Allow appending chunked data to the file. This disables fields container content deduplication. | +| Pin -5| dataset_size_compression_threshold |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Integer value that defines the minimum dataset size (in bytes) to use h5 native compression Applicable for arrays of floats, doubles and integers. | +| Pin -2| h5_native_compression |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | Integer value / DataTree that defines the h5 native compression used For Integer Input {0: No Compression (default); 1-9: GZIP Compression : 9 provides maximum compression but at the slowest speed.}For DataTree Input {type: None / GZIP / ZSTD; level: GZIP (1-9) / ZSTD (1-20); num_threads: ZSTD (>0)} | +| Pin -1| export_floats |[`bool`](../../core-concepts/dpf-types.md#standard-types) | converts double to float to reduce file size (default is true) | +| Pin 0
Required| filename |[`string`](../../core-concepts/dpf-types.md#standard-types) | name of the output file that will be generated (utf8). | | Pin 1| mesh_provider_out |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | defines the MeshedRegion that is exported and provided by MeshProvider. | | Pin 2| time_freq_support_out |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | defines the TimeFreqSupport that is exported and provided by TimeFreqSupportProvider. | -| Pin 3| ansys_unit_system_id |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`result_info`](../../core-concepts/dpf-types.md#result-info) | defines the unit system the results are exported with. A Result info can be input to also export Physics Type and Analysis Type. | -| Pin 4| input_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`any`](../../core-concepts/dpf-types.md#any) | Set of even and odd pins to serialize results. Odd pins (4, 6, 8...) are strings, and they represent the names of the results to be serialized. Even pins (5, 7, 9...) are DPF types, and they represent the results to be serialized. They should go in pairs (for each result name, there should be a result) and connected sequentially. | +| Pin 3| ansys_unit_system_id |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`result_info`](../../core-concepts/dpf-types.md#result-info) | defines the unit system the results are exported with. A Result info can be input to also export Physics Type and Analysis Type. | +| Pin 4| input_name |[`string`](../../core-concepts/dpf-types.md#standard-types), [`any`](../../core-concepts/dpf-types.md#any) | Set of even and odd pins to serialize results. Odd pins (4, 6, 8...) are strings, and they represent the names of the results to be serialized. Even pins (5, 7, 9...) are DPF types, and they represent the results to be serialized. They should go in pairs (for each result name, there should be a result) and connected sequentially. | ## Outputs @@ -36,8 +36,8 @@ Generate a dpf result file from provided information. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **evaluate_inputs_before_run** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, all input pins of the operator will be evaluated before entering the run method to maintain a correct Operator status. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **evaluate_inputs_before_run** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, all input pins of the operator will be evaluated before entering the run method to maintain a correct Operator status. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/import_symbolic_workflow.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/import_symbolic_workflow.md index da0230223c..6bc6c7d0d9 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/import_symbolic_workflow.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/import_symbolic_workflow.md @@ -16,8 +16,8 @@ Reads a file or string holding a Symbolic Workflow and instantiate a WorkFlow wi | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| string_or_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | -| Pin 2| format |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | -1 is auto-detection, 0 is ASCII format, 1 is binary, 2 is json, default is -1 (auto-detection). | +| Pin 0
Required| string_or_path |[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 2| format |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -1 is auto-detection, 0 is ASCII format, 1 is binary, 2 is json, default is -1 (auto-detection). | ## Outputs @@ -29,7 +29,7 @@ Reads a file or string holding a Symbolic Workflow and instantiate a WorkFlow wi | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/json_to_data_tree.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/json_to_data_tree.md index a3f6cb9dce..da1aa5a392 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/json_to_data_tree.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/json_to_data_tree.md @@ -16,7 +16,7 @@ Reads a json file or string to a DataTree | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| string_or_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 0
Required| string_or_path |[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs @@ -28,7 +28,7 @@ Reads a json file or string to a DataTree | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/mechanical_csv_to_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/mechanical_csv_to_field.md index 86fd317be0..05b95ee5ff 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/mechanical_csv_to_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/mechanical_csv_to_field.md @@ -19,7 +19,7 @@ Reads mechanical exported csv file | Pin 0
Required| unit |class dataProcessing::unit::CUnit | | | Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | -| Pin 9
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`field_definition`](../../core-concepts/dpf-types.md#field-definition) | | +| Pin 9
Required| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types), [`field_definition`](../../core-concepts/dpf-types.md#field-definition) | | ## Outputs @@ -31,7 +31,7 @@ Reads mechanical exported csv file | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/migrate_file_to_vtk.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/migrate_file_to_vtk.md index 8d827e8fa0..f87f458e70 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/migrate_file_to_vtk.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/migrate_file_to_vtk.md @@ -16,7 +16,7 @@ Take an input data sources or streams and convert as much data as possible to vt | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| output_filename |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0| output_filename |[`string`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | @@ -30,7 +30,7 @@ Take an input data sources or streams and convert as much data as possible to vt | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/migrate_to_vtu.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/migrate_to_vtu.md index 1b7b2df330..e10e760743 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/migrate_to_vtu.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/migrate_to_vtu.md @@ -16,13 +16,13 @@ Extract all results from a datasources and exports them into vtu format. All the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | time sets to export, default is all | +| Pin 0| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | time sets to export, default is all | | Pin 3| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set | -| Pin 20
Required| directory |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | directory path | -| Pin 21| base_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | vtu base file name, (default is file) | -| Pin 30| result |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | if Operator's names are connected to this Pin, only these results are exported (else all available results are exported) | -| Pin 100| write_mode |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Available are rawbinarycompressed, rawbinary, base64appended, base64inline, ascii, default is (rawbinarycompressed) | +| Pin 20
Required| directory |[`string`](../../core-concepts/dpf-types.md#standard-types) | directory path | +| Pin 21| base_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | vtu base file name, (default is file) | +| Pin 30| result |[`string`](../../core-concepts/dpf-types.md#standard-types) | if Operator's names are connected to this Pin, only these results are exported (else all available results are exported) | +| Pin 100| write_mode |[`string`](../../core-concepts/dpf-types.md#standard-types) | Available are rawbinarycompressed, rawbinary, base64appended, base64inline, ascii, default is (rawbinarycompressed) | ## Outputs @@ -34,8 +34,8 @@ Extract all results from a datasources and exports them into vtu format. All the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/serialize_to_hdf5.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/serialize_to_hdf5.md index 0e245d0f5b..e519a790b1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/serialize_to_hdf5.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/serialize_to_hdf5.md @@ -16,9 +16,9 @@ This operator is deprecated: use 'hdf5::h5dpf::make_result_file' instead. Serial | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | output file path with .h5 extension | -| Pin 1| export_floats |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | converts double to float to reduce file size (default is true) | -| Pin 2| export_flat_vectors |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, vectors and matrices data are exported flat (x1,y1,z1,x2,y2,z2..) (default is false) | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | output file path with .h5 extension | +| Pin 1| export_floats |[`bool`](../../core-concepts/dpf-types.md#standard-types) | converts double to float to reduce file size (default is true) | +| Pin 2| export_flat_vectors |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, vectors and matrices data are exported flat (x1,y1,z1,x2,y2,z2..) (default is false) | | Pin 3
Required| data | | only the data set explicitly to export is exported | ## Outputs @@ -30,7 +30,7 @@ This operator is deprecated: use 'hdf5::h5dpf::make_result_file' instead. Serial | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/serializer.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/serializer.md index 763373d090..7136fc4821 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/serializer.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/serializer.md @@ -16,21 +16,21 @@ Take any input and serialize them in a file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1
Required| stream_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 for ASCII (default), and 1 for binary | -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin -1
Required| stream_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 for ASCII (default), and 1 for binary | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 1
Required| any_input |[`any`](../../core-concepts/dpf-types.md#any) | any input | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/serializer_to_string.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/serializer_to_string.md index 08cfae089b..d802c53911 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/serializer_to_string.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/serializer_to_string.md @@ -16,21 +16,21 @@ Take any input and serialize them in a string. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1
Required| stream_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 for string (default), 1 for binary, 2 for binary with chunked output (the output string will be returned in several chunks to prevent string memory overflows). | +| Pin -1
Required| stream_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 for string (default), 1 for binary, 2 for binary with chunked output (the output string will be returned in several chunks to prevent string memory overflows). | | Pin 1
Required| any_input |[`any`](../../core-concepts/dpf-types.md#any) | any input | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin -1**| nof_chunks |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Number of chunks when mode passed to input pin(-1) = 2. | -| **Pin 0**| serialized_string |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin -1**| nof_chunks |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of chunks when mode passed to input pin(-1) = 2. | +| **Pin 0**| serialized_string |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/string_deserializer.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/string_deserializer.md index 2fee596522..79dc58a4fd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/string_deserializer.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/string_deserializer.md @@ -16,8 +16,8 @@ Takes a string generated by the serializer and deserializes it into DPF's entiti | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1
Required| stream_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 for string (default), and 1 for binary | -| Pin 0
Required| serialized_string |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin -1
Required| stream_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 for string (default), and 1 for binary | +| Pin 0
Required| serialized_string |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -29,7 +29,7 @@ Takes a string generated by the serializer and deserializes it into DPF's entiti | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/txt_to_data_tree.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/txt_to_data_tree.md index 656e876000..a6986a03a1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/txt_to_data_tree.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/txt_to_data_tree.md @@ -16,7 +16,7 @@ Reads a txt file or string to a DataTree | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| string_or_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | +| Pin 0
Required| string_or_path |[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | ## Outputs @@ -28,7 +28,7 @@ Reads a txt file or string to a DataTree | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/vtk_export.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/vtk_export.md index 6e6bb9960a..9ea73561fd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/vtk_export.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/vtk_export.md @@ -16,8 +16,8 @@ Write the input field and fields container into a given vtk path | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1| export_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Either export volume elements in the mesh with their fields with value 0 or faces elements in the mesh with their fields with value 1 (default is 0) | -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | path with vtk extension were the export occurs | +| Pin -1| export_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Either export volume elements in the mesh with their fields with value 0 or faces elements in the mesh with their fields with value 1 (default is 0) | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | path with vtk extension were the export occurs | | Pin 1| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | necessary if the first field or fields container don't have a mesh in their support | | Pin 2
Required| fields |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | fields exported | @@ -30,7 +30,7 @@ Write the input field and fields container into a given vtk path | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/vtk_to_fields.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/vtk_to_fields.md index 1adb681a00..944a6c55e8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/vtk_to_fields.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/vtk_to_fields.md @@ -16,7 +16,7 @@ Write a field based on a vtk file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| field_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | name of the field in the vtk file | +| Pin 0| field_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | name of the field in the vtk file | | Pin 3| streams |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | | Pin 4
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | @@ -30,7 +30,7 @@ Write a field based on a vtk file. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/vtu_export.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/vtu_export.md index 3aa2771597..c0946571c3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/vtu_export.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/vtu_export.md @@ -16,14 +16,14 @@ Export DPF data into vtu format. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| directory |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | directory path | -| Pin 1| base_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | vtu base file name, (default is file) | +| Pin 0
Required| directory |[`string`](../../core-concepts/dpf-types.md#standard-types) | directory path | +| Pin 1| base_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | vtu base file name, (default is file) | | Pin 2
Required| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | mesh | | Pin 3
Required| fields |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field) | Nodal, Face, or Elemental field, fields container (over time), or property field to export. When there is no support available in the exported mesh, that data is ignored. | -| Pin 100| write_mode |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Available are rawbinarycompressed, rawbinary, base64appended, base64inline, ascii, default is (rawbinarycompressed) | -| Pin 101| as_point_cloud |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to export the mesh as a point cloud. Default is False. | -| Pin 102| export_faces |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Whether to also export faces as shell elements when the mesh contains cells. Default is False. | -| Pin 103| mesh_properties |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`string_field`](../../core-concepts/dpf-types.md#string-field) | List of names of mesh properties to export. | +| Pin 100| write_mode |[`string`](../../core-concepts/dpf-types.md#standard-types) | Available are rawbinarycompressed, rawbinary, base64appended, base64inline, ascii, default is (rawbinarycompressed) | +| Pin 101| as_point_cloud |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Whether to export the mesh as a point cloud. Default is False. | +| Pin 102| export_faces |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Whether to also export faces as shell elements when the mesh contains cells. Default is False. | +| Pin 103| mesh_properties |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`string_field`](../../core-concepts/dpf-types.md#string-field) | List of names of mesh properties to export. | ## Outputs @@ -35,8 +35,8 @@ Export DPF data into vtu format. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/workflow_to_pydpf.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/workflow_to_pydpf.md index 00511eb194..fa844170a2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/workflow_to_pydpf.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/workflow_to_pydpf.md @@ -18,19 +18,19 @@ The script is returned as a string, and can optionally be saved to a specified p | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| workflow |[`workflow`](../../core-concepts/dpf-types.md#workflow) | | -| Pin 1| output_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1| output_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| pydpf_code |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| pydpf_code |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/workflow_to_workflow_topology.md b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/workflow_to_workflow_topology.md index 8faf708fcf..b378bf37a2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/serialization/workflow_to_workflow_topology.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/serialization/workflow_to_workflow_topology.md @@ -28,7 +28,7 @@ Creates a GenericDataContainer based on WorkflowTopology structure from a Workfl | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/server/grpc_shutdown_server.md b/2025R2/dpf-framework-25-r2/operator-specifications/server/grpc_shutdown_server.md index 518f532581..2329fdef0c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/server/grpc_shutdown_server.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/server/grpc_shutdown_server.md @@ -27,7 +27,7 @@ Shutdowns dpf's grpc server | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/server/grpc_start_server.md b/2025R2/dpf-framework-25-r2/operator-specifications/server/grpc_start_server.md index 39caa2c361..f8317d968a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/server/grpc_start_server.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/server/grpc_start_server.md @@ -16,12 +16,12 @@ Starts a dpf's grpc server (if local) or connect to one and keep it waiting for | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| ip |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | If no ip address is put, the local ip address is taken | -| Pin 1| port |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | If no port is put, port 50052 is taken | -| Pin 2| starting_option |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | default is 1 that starts server in new thread. With 0, this thread will be waiting for grpc calls and will not be usable for anything else. With 2, it the server will be started in a new process. | -| Pin 3| should_start_server |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, the server is assumed to be local and is started. If false, only a client (able to send grpc calls) will be started | +| Pin 0| ip |[`string`](../../core-concepts/dpf-types.md#standard-types) | If no ip address is put, the local ip address is taken | +| Pin 1| port |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | If no port is put, port 50052 is taken | +| Pin 2| starting_option |[`int32`](../../core-concepts/dpf-types.md#standard-types) | default is 1 that starts server in new thread. With 0, this thread will be waiting for grpc calls and will not be usable for anything else. With 2, it the server will be started in a new process. | +| Pin 3| should_start_server |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the server is assumed to be local and is started. If false, only a client (able to send grpc calls) will be started | | Pin 4| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | A data source with result key 'grpc' and file path 'port:ip' can be used instead of the input port and IP. | -| Pin 5| dpf_context |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | This pin is associated with pin(2) = 2 (server started in a new process). User can enter the integer associated with a DPF context (1: Standalone Context - DpfCoreStandalone.xml, 3: Custom - DpfCustomDefined.xml) or a string with the path of the XML specifying the context. | +| Pin 5| dpf_context |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | This pin is associated with pin(2) = 2 (server started in a new process). User can enter the integer associated with a DPF context (1: Standalone Context - DpfCoreStandalone.xml, 3: Custom - DpfCustomDefined.xml) or a string with the path of the XML specifying the context. | ## Outputs @@ -33,7 +33,7 @@ Starts a dpf's grpc server (if local) or connect to one and keep it waiting for | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/append_zeros_to_signal.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/append_zeros_to_signal.md index d18ea3c35d..a228140c24 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/append_zeros_to_signal.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/append_zeros_to_signal.md @@ -17,7 +17,7 @@ Append samples with value zero at the end of the signal, to extend its duration. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Input signal. | -| Pin 1
Required| duration_to_append |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Duration, in seconds, of the zeros to append to the input signal. | +| Pin 1
Required| duration_to_append |[`double`](../../core-concepts/dpf-types.md#standard-types) | Duration, in seconds, of the zeros to append to the input signal. | ## Outputs @@ -29,7 +29,7 @@ Append samples with value zero at the end of the signal, to extend its duration. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/apply_gain.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/apply_gain.md index a5d740af11..c4cfa37cf9 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/apply_gain.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/apply_gain.md @@ -17,8 +17,8 @@ Apply gain on each channel of a signal (fields_container). Note: The gain is ap | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | The input signal. | -| Pin 1
Required| gain |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Gain value in decibels (dB) or linear unit. By default, gain is specified in decibels. If gain is given in a linear unit, set is_gain_dB to false. | -| Pin 2
Required| is_gain_dB |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If value is true, the gain is specified in dB. If value is false, the gain is in a linear unit. | +| Pin 1
Required| gain |[`double`](../../core-concepts/dpf-types.md#standard-types) | Gain value in decibels (dB) or linear unit. By default, gain is specified in decibels. If gain is given in a linear unit, set is_gain_dB to false. | +| Pin 2
Required| is_gain_dB |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If value is true, the gain is specified in dB. If value is false, the gain is in a linear unit. | ## Outputs @@ -30,7 +30,7 @@ Apply gain on each channel of a signal (fields_container). Note: The gain is ap | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_PR.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_PR.md index e5f4324c8f..70b76df2b3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_PR.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_PR.md @@ -17,7 +17,7 @@ Compute the Prominence Ratio (PR) according to the ECMA-418-1 (formerly ECMA-74, | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_levels |[`field`](../../core-concepts/dpf-types.md#field) | Input PSD levels in Pa^2/Hz on which to compute PR, as a field. The PSD's frequencies must be regularly spaced. If the PSD's lowest frequency is not 0 Hz, values between 0 Hz and the PSD's lowest frequency are set to 0. | -| Pin 1| frequency_list |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) list of the frequencies of the tones (peaks in the spectrum) for which to compute PR. If this input is empty (not specified), a peak detection method is applied to automatically find the tones in the input spectrum. Then, the PR is calculated for each detected tone. | +| Pin 1| frequency_list |[`vector`](../../core-concepts/dpf-types.md#standard-types) | (Optional) list of the frequencies of the tones (peaks in the spectrum) for which to compute PR. If this input is empty (not specified), a peak detection method is applied to automatically find the tones in the input spectrum. Then, the PR is calculated for each detected tone. | ## Outputs @@ -29,7 +29,7 @@ Compute the Prominence Ratio (PR) according to the ECMA-418-1 (formerly ECMA-74, | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_TNR.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_TNR.md index 0cd31916ab..7aa835934c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_TNR.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_TNR.md @@ -17,7 +17,7 @@ Compute the Tone-to-Noise Ratio (TNR) according to the ECMA-418-1 (former ECMA-7 | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_levels |[`field`](../../core-concepts/dpf-types.md#field) | Input PSD levels in Pa^2/Hz on which to compute PR, as a field. The PSD's frequencies must be regularly spaced. If the PSD's lowest frequency is not 0 Hz, values between 0 Hz and the PSD's lowest frequency are set to 0. | -| Pin 1| frequency_list |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) list of the frequencies of the tones (peaks in the spectrum) for which to compute PR. If this input is empty (not specified), a peak detection method is applied to automatically find the tones in the input spectrum. Then, the PR is calculated for each detected tone. | +| Pin 1| frequency_list |[`vector`](../../core-concepts/dpf-types.md#standard-types) | (Optional) list of the frequencies of the tones (peaks in the spectrum) for which to compute PR. If this input is empty (not specified), a peak detection method is applied to automatically find the tones in the input spectrum. Then, the PR is calculated for each detected tone. | ## Outputs @@ -29,7 +29,7 @@ Compute the Tone-to-Noise Ratio (TNR) according to the ECMA-418-1 (former ECMA-7 | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_fluctuation_strength.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_fluctuation_strength.md index 94e5497ce3..278eb858ac 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_fluctuation_strength.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_fluctuation_strength.md @@ -22,14 +22,14 @@ Compute the fluctuation strength of a signal based on the master thesis of A. So | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_fluctuation_strength |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Fluctuation strength in vacil. | +| **Pin 0**| output_fluctuation_strength |[`double`](../../core-concepts/dpf-types.md#standard-types) | Fluctuation strength in vacil. | | **Pin 1**| output_specific_fluctuation_strength |[`field`](../../core-concepts/dpf-types.md#field) | Specific fluctuation strength in vacil, that is, the fluctuation strength values over Bark band indexes. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_istft.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_istft.md index 3958aa7457..d562be5327 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_istft.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_istft.md @@ -29,7 +29,7 @@ Compute Inverse Short-Time Fourier Transform (ISTFT). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_level_over_time.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_level_over_time.md index fd5a69c1ce..83740cbcde 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_level_over_time.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_level_over_time.md @@ -17,26 +17,26 @@ Compute level over time of a signal, on a decibel (dB) scale, or a linear, root- | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal for the level computation. | -| Pin 1| scale_unit |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Expected level scale unit, that is, whether level should be output on a decibel scale, or on a linear, root-mean-square (RMS) scale. Supported values are: - 0: dB; - 1: RMS. Default: 0 (dB). | -| Pin 2| reference_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Reference value for dB calculation. For example, 2e-5 Pa is the reference value for dB SPL, dBA, dBB, and dBC. Reference value is ignored if input scale_unit is set to 1 (RMS). If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa. Default: 1.0. | -| Pin 3| frequency_weighting |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Frequency weighting for dB calculation. Frequency weighting is ignored if input scale_unit is set to 1 (RMS). Supported values are: - 0: Z-weigthing (no frequency weighting, use this setting in case dB SPL); - 1: A-weigthing; - 2: B-weigthing; - 3: C-weigthing. If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa.Default: 0 (Z-weighting). | -| Pin 4| time_weighting |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Time weighting for dB calculation, as described in the IEC-61672 standard. Supported values are: - 0: Slow; - 1: Fast; - 2: Impulse; - 3: Custom; Default: 1 (Fast). | -| Pin 5| time_step |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Time step of the level over time calculation, in seconds. Time step is ignored if input time_weighting is not set to 3 (Custom). Default: 0.025 s. | -| Pin 6| window_size |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Window size in seconds, that is, the length of the slice of signal used to calculate the level at each time step. Window size is ignored if input time_weighting is not set to 3 (Custom). Default value: 1s. | -| Pin 7| window_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Type of the window applied to the slice of signal used to calculate the level at each time step. Supported values are:'RECTANGULAR', 'HANN', 'HAMMING', 'BLACKMAN', 'BLACKMANHARRIS', 'BARTLETT'.Default: 'RECTANGULAR'. | +| Pin 1| scale_unit |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Expected level scale unit, that is, whether level should be output on a decibel scale, or on a linear, root-mean-square (RMS) scale. Supported values are: - 0: dB; - 1: RMS. Default: 0 (dB). | +| Pin 2| reference_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Reference value for dB calculation. For example, 2e-5 Pa is the reference value for dB SPL, dBA, dBB, and dBC. Reference value is ignored if input scale_unit is set to 1 (RMS). If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa. Default: 1.0. | +| Pin 3| frequency_weighting |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Frequency weighting for dB calculation. Frequency weighting is ignored if input scale_unit is set to 1 (RMS). Supported values are: - 0: Z-weigthing (no frequency weighting, use this setting in case dB SPL); - 1: A-weigthing; - 2: B-weigthing; - 3: C-weigthing. If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa.Default: 0 (Z-weighting). | +| Pin 4| time_weighting |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Time weighting for dB calculation, as described in the IEC-61672 standard. Supported values are: - 0: Slow; - 1: Fast; - 2: Impulse; - 3: Custom; Default: 1 (Fast). | +| Pin 5| time_step |[`double`](../../core-concepts/dpf-types.md#standard-types) | Time step of the level over time calculation, in seconds. Time step is ignored if input time_weighting is not set to 3 (Custom). Default: 0.025 s. | +| Pin 6| window_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | Window size in seconds, that is, the length of the slice of signal used to calculate the level at each time step. Window size is ignored if input time_weighting is not set to 3 (Custom). Default value: 1s. | +| Pin 7| window_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Type of the window applied to the slice of signal used to calculate the level at each time step. Supported values are:'RECTANGULAR', 'HANN', 'HAMMING', 'BLACKMAN', 'BLACKMANHARRIS', 'BARTLETT'.Default: 'RECTANGULAR'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| maximum_level |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Maximum level attained by the level over time curve, in the unit specified according to inputs (dB, dB SPL, dBA, dBB, dBC or RMS). | +| **Pin 0**| maximum_level |[`double`](../../core-concepts/dpf-types.md#standard-types) | Maximum level attained by the level over time curve, in the unit specified according to inputs (dB, dB SPL, dBA, dBB, dBC or RMS). | | **Pin 1**| level_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Level over time, in a unit that depends on inputs scale_unit, reference_value, and frequency_weighting. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_ansi_s3_4.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_ansi_s3_4.md index 6f3958275f..5ded8a6d43 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_ansi_s3_4.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_ansi_s3_4.md @@ -17,20 +17,20 @@ Compute loudness according to the ANSI S3.4-2007 standard. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute loudness. | -| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_loudness_sone |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Loudness in sone. | -| **Pin 1**| output_loudness_phon |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Loudness level in phon. | +| **Pin 0**| output_loudness_sone |[`double`](../../core-concepts/dpf-types.md#standard-types) | Loudness in sone. | +| **Pin 1**| output_loudness_phon |[`double`](../../core-concepts/dpf-types.md#standard-types) | Loudness level in phon. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_1.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_1.md index 1bb77fe4e7..06059967e3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_1.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_1.md @@ -17,21 +17,21 @@ Compute loudness according to the ISO532-1 standard for stationary sounds. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute loudness. | -| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_loudness_sone |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Loudness in sone. | -| **Pin 1**| output_loudness_phon |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Loudness level in phon. | +| **Pin 0**| output_loudness_sone |[`double`](../../core-concepts/dpf-types.md#standard-types) | Loudness in sone. | +| **Pin 1**| output_loudness_phon |[`double`](../../core-concepts/dpf-types.md#standard-types) | Loudness level in phon. | | **Pin 2**| output_specific_loudness |[`field`](../../core-concepts/dpf-types.md#field) | Specific loudness in sone/Bark, that is, the loudness values over Bark band indexes. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_1_frequency_input.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_1_frequency_input.md index 1d62a159d0..81dab5d38e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_1_frequency_input.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_1_frequency_input.md @@ -17,21 +17,21 @@ Compute loudness according to the ISO532-1 standard for stationary sounds, using | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_levels |[`field`](../../core-concepts/dpf-types.md#field) | Input one-third-octave-band levels in dB SPL on which to compute loudness. Exactly 28 band levels must be provided. Considered one-third-octave bands have the following central frequencies: - Band 1: 25 Hz;- Band 2: 31.5 Hz;- Band 3: 40 Hz;- Band 4: 50 Hz;- Band 5: 63 Hz;- Band 6: 80 Hz;- Band 7: 100 Hz;- Band 8: 125 Hz;- Band 9: 160 Hz;- Band 10: 200 Hz;- Band 11: 250 Hz;- Band 12: 315 Hz;- Band 13: 400 Hz;- Band 14: 500 Hz;- Band 15: 630 Hz;- Band 16: 800 Hz;- Band 17: 1000 Hz;- Band 18: 1250 Hz;- Band 19: 1600 Hz;- Band 20: 2000 Hz;- Band 21: 2500 Hz;- Band 22: 3150 Hz;- Band 23: 4000 Hz;- Band 24: 5000 Hz;- Band 25: 6300 Hz;- Band 26: 8000 Hz;- Band 27: 10000 Hz;- Band 28: 12500 Hz. | -| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_loudness_sone |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Loudness in sone. | -| **Pin 1**| output_loudness_phon |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Loudness level in phon. | +| **Pin 0**| output_loudness_sone |[`double`](../../core-concepts/dpf-types.md#standard-types) | Loudness in sone. | +| **Pin 1**| output_loudness_phon |[`double`](../../core-concepts/dpf-types.md#standard-types) | Loudness level in phon. | | **Pin 2**| output_specific_loudness |[`field`](../../core-concepts/dpf-types.md#field) | Specific loudness in sone/Bark, that is, the loudness values over Bark band indexes. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_1_vs_time.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_1_vs_time.md index 82a13751a4..e56bfb95cd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_1_vs_time.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_1_vs_time.md @@ -17,24 +17,24 @@ Compute the loudness over time of an input signal, according to the ISO532-1 sta | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute loundess over time. | -| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| | **Pin 0**| output_loudness_sone_vs_time |[`field`](../../core-concepts/dpf-types.md#field) | Instantaneous loudness in sone. | -| **Pin 1**| output_N5 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | N5 indicator in sone, that is, the loudness value that is exceeded during a cumulated 5 % of the signal duration. | -| **Pin 2**| output_N10 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | N10 indicator in sone, that is, the loudness value that is exceeded during a cumulated 10 % of the signal duration. | +| **Pin 1**| output_N5 |[`double`](../../core-concepts/dpf-types.md#standard-types) | N5 indicator in sone, that is, the loudness value that is exceeded during a cumulated 5 % of the signal duration. | +| **Pin 2**| output_N10 |[`double`](../../core-concepts/dpf-types.md#standard-types) | N10 indicator in sone, that is, the loudness value that is exceeded during a cumulated 10 % of the signal duration. | | **Pin 3**| output_loudness_phon_vs_time |[`field`](../../core-concepts/dpf-types.md#field) | Instantaneous loudness level in phon. | -| **Pin 4**| output_L5 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | L5 indicator in phon, that is, the loudness level value that is exceeded during a cumulated 5 % of the signal duration. | -| **Pin 5**| output_L10 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | L10 indicator in phon, that is, the loudness level value that is exceeded during a cumulated 10 % of the signal duration. | +| **Pin 4**| output_L5 |[`double`](../../core-concepts/dpf-types.md#standard-types) | L5 indicator in phon, that is, the loudness level value that is exceeded during a cumulated 5 % of the signal duration. | +| **Pin 5**| output_L10 |[`double`](../../core-concepts/dpf-types.md#standard-types) | L10 indicator in phon, that is, the loudness level value that is exceeded during a cumulated 10 % of the signal duration. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_2.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_2.md index 582511a935..39dff805ea 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_2.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_loudness_iso532_2.md @@ -17,17 +17,17 @@ Compute binaural and monaural loudness according to the ISO532-2 standard. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Input signal in Pa on which to compute loudness. If signal is a FieldsContainer, it must contain exactly two Fields. | -| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | -| Pin 2| recording_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Recording system used to measure the input signal (supported values: 'Mic', 'Head'. 'Mic' stands for Single microphone, 'Head' stands for Head and torso simulator). Default: 'Mic'. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 2| recording_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Recording system used to measure the input signal (supported values: 'Mic', 'Head'. 'Mic' stands for Single microphone, 'Head' stands for Head and torso simulator). Default: 'Mic'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_binaural_loudness_sone |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Binaural loudness in sone. | -| **Pin 1**| output_binaural_loudness_phon |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Binaural loudness level in phon. | -| **Pin 2**| output_monaural_loudness_sone |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Monaural loudness (left and right) in sone. | -| **Pin 3**| output_monaural_loudness_phon |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Monaural loudness (left and right) level in phon. | +| **Pin 0**| output_binaural_loudness_sone |[`double`](../../core-concepts/dpf-types.md#standard-types) | Binaural loudness in sone. | +| **Pin 1**| output_binaural_loudness_phon |[`double`](../../core-concepts/dpf-types.md#standard-types) | Binaural loudness level in phon. | +| **Pin 2**| output_monaural_loudness_sone |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Monaural loudness (left and right) in sone. | +| **Pin 3**| output_monaural_loudness_phon |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Monaural loudness (left and right) level in phon. | | **Pin 4**| output_binaural_specific_loudness |[`field`](../../core-concepts/dpf-types.md#field) | Binaural specific loudness in sone/Cam. | | **Pin 5**| output_monaural_specific_loudness |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Monaural specific loudness (left and right) in sone/Cam. | @@ -35,7 +35,7 @@ Compute binaural and monaural loudness according to the ISO532-2 standard. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_overall_level.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_overall_level.md index 39f654b9e7..78b53f5f86 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_overall_level.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_overall_level.md @@ -17,21 +17,21 @@ Compute the overall level of a signal, on a decibel scale or a linear, root-mean | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal for the level computation. | -| Pin 1| scale_unit |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Expected level scale unit, that is, whether level should be output on a decibel scale, or on a linear, root-mean-square (RMS) scale. Supported values are: - 0: dB; - 1: RMS. Default: 0 (dB). | -| Pin 2| reference_value |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Reference value for dB calculation. For example, 2e-5 Pa is the reference value for dB SPL, dBA, dBB, and dBC. Reference value is ignored if input scale_unit is set to 1 (RMS). If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa. Default: 1.0. | -| Pin 3| frequency_weighting |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Frequency weighting for dB calculation. Frequency weighting is ignored if input scale_unit is set to 1 (RMS). Supported values are: - 0: Z-weigthing (no frequency weighting, use this setting in case dB SPL); - 1: A-weigthing; - 2: B-weigthing; - 3: C-weigthing; If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa.Default: 0 (Z-weighting). | +| Pin 1| scale_unit |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Expected level scale unit, that is, whether level should be output on a decibel scale, or on a linear, root-mean-square (RMS) scale. Supported values are: - 0: dB; - 1: RMS. Default: 0 (dB). | +| Pin 2| reference_value |[`double`](../../core-concepts/dpf-types.md#standard-types) | Reference value for dB calculation. For example, 2e-5 Pa is the reference value for dB SPL, dBA, dBB, and dBC. Reference value is ignored if input scale_unit is set to 1 (RMS). If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa. Default: 1.0. | +| Pin 3| frequency_weighting |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Frequency weighting for dB calculation. Frequency weighting is ignored if input scale_unit is set to 1 (RMS). Supported values are: - 0: Z-weigthing (no frequency weighting, use this setting in case dB SPL); - 1: A-weigthing; - 2: B-weigthing; - 3: C-weigthing; If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa.Default: 0 (Z-weighting). | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_level |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Overall level, in a unit that depends on inputs scale_unit, reference_value, and frequency_weighting. | +| **Pin 0**| output_level |[`double`](../../core-concepts/dpf-types.md#standard-types) | Overall level, in a unit that depends on inputs scale_unit, reference_value, and frequency_weighting. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_power_spectral_density.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_power_spectral_density.md index c0e1cb696f..fbeb60fe60 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_power_spectral_density.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_power_spectral_density.md @@ -17,10 +17,10 @@ Compute the Power Spectral Density (PSD) of a signal. If the signal's unit is Un | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal for PSD computation. | -| Pin 1
Required| window_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | The window used for the FFT computation, as a string. Supported values are: 'BLACKMAN', 'FLATTOP', 'GAUSS','HAMMING', 'HANN', 'RECTANGULAR', 'TRIANGULAR'. If no parameter is specified, the default value is 'HANN'. | -| Pin 2
Required| window_length |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Length of the analysis window in number of samples. | -| Pin 3
Required| fft_size |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | FFT size in number of samples, must be a power of 2. Should be equal to or greater than window_length. | -| Pin 4
Required| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Proportion of each window that overlaps with the next, must be in the range [0.0, 1.0[. | +| Pin 1
Required| window_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | The window used for the FFT computation, as a string. Supported values are: 'BLACKMAN', 'FLATTOP', 'GAUSS','HAMMING', 'HANN', 'RECTANGULAR', 'TRIANGULAR'. If no parameter is specified, the default value is 'HANN'. | +| Pin 2
Required| window_length |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Length of the analysis window in number of samples. | +| Pin 3
Required| fft_size |[`int32`](../../core-concepts/dpf-types.md#standard-types) | FFT size in number of samples, must be a power of 2. Should be equal to or greater than window_length. | +| Pin 4
Required| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | Proportion of each window that overlaps with the next, must be in the range [0.0, 1.0[. | ## Outputs @@ -32,7 +32,7 @@ Compute the Power Spectral Density (PSD) of a signal. If the signal's unit is Un | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_prominence_ratio_for_orders_over_time.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_prominence_ratio_for_orders_over_time.md index 40bf7a009b..91256ee467 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_prominence_ratio_for_orders_over_time.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_prominence_ratio_for_orders_over_time.md @@ -18,7 +18,7 @@ Compute the Prominence Ratio (PR) over time of a signal, for specific order(s), |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the PR over time for the specified orders. | | Pin 1
Required| rpm_profile |[`field`](../../core-concepts/dpf-types.md#field) | Profile of RPM over time associated with the input signal. Must have the same length and same sampling frequency as the input signal. | -| Pin 2
Required| orders_numbers |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | List of the order numbers for which to compute PR. | +| Pin 2
Required| orders_numbers |[`vector`](../../core-concepts/dpf-types.md#standard-types) | List of the order numbers for which to compute PR. | ## Outputs @@ -31,7 +31,7 @@ Compute the Prominence Ratio (PR) over time of a signal, for specific order(s), | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_roughness.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_roughness.md index b7b19ef53d..5f1e2b1407 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_roughness.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_roughness.md @@ -22,7 +22,7 @@ Compute the roughness of a signal, based on the reference paper from Daniel and | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| overall_roughness |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Overall roughness in asper. | +| **Pin 0**| overall_roughness |[`double`](../../core-concepts/dpf-types.md#standard-types) | Overall roughness in asper. | | **Pin 1**| specific_roughness |[`field`](../../core-concepts/dpf-types.md#field) | Specific roughness in asper/Bark, that is, the roughness values over Bark band indexes. | | **Pin 2**| roughness_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Roughness over time in asper. | @@ -30,7 +30,7 @@ Compute the roughness of a signal, based on the reference paper from Daniel and | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness.md index 88c658a4f3..97970b37ac 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness.md @@ -17,19 +17,19 @@ Compute the sharpness of a signal, according to Zwicker and Fastl's formula (E. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute sharpness. | -| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Sharpness in acum. | +| **Pin 0**| output_sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types) | Sharpness in acum. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness_din45692.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness_din45692.md index 10b495909c..31bc85b254 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness_din45692.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness_din45692.md @@ -17,21 +17,21 @@ Compute the overall sharpness and sharpness over time of a signal, where sharpne | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input in Pa on which to compute the DIN 45692 sharpness. | -| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Overall sharpness in acum (based on ISO 532-1 stationary specific loudness). | -| **Pin 1**| max_sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Maximum sharpness over time in acum (based on ISO 532-1 time-varying specific loudness). | +| **Pin 0**| sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types) | Overall sharpness in acum (based on ISO 532-1 stationary specific loudness). | +| **Pin 1**| max_sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types) | Maximum sharpness over time in acum (based on ISO 532-1 time-varying specific loudness). | | **Pin 2**| sharpness_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Sharpness over time in acum (based on ISO 532-1 time-varying specific loudness). | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness_frequency_input.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness_frequency_input.md index 3fbe3bccff..649f85bc33 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness_frequency_input.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness_frequency_input.md @@ -17,19 +17,19 @@ Compute sharpness according to Zwicker and Fastl's formula (E. Zwicker and H. Fa | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_levels |[`field`](../../core-concepts/dpf-types.md#field) | Input one-third-octave-band levels in dB SPL on which to compute sharpness. Exactly 28 band levels must be provided. Considered one-third-octave bands have the following central frequencies: - Band 1: 25 Hz;- Band 2: 31.5 Hz;- Band 3: 40 Hz;- Band 4: 50 Hz;- Band 5: 63 Hz;- Band 6: 80 Hz;- Band 7: 100 Hz;- Band 8: 125 Hz;- Band 9: 160 Hz;- Band 10: 200 Hz;- Band 11: 250 Hz;- Band 12: 315 Hz;- Band 13: 400 Hz;- Band 14: 500 Hz;- Band 15: 630 Hz;- Band 16: 800 Hz;- Band 17: 1000 Hz;- Band 18: 1250 Hz;- Band 19: 1600 Hz;- Band 20: 2000 Hz;- Band 21: 2500 Hz;- Band 22: 3150 Hz;- Band 23: 4000 Hz;- Band 24: 5000 Hz;- Band 25: 6300 Hz;- Band 26: 8000 Hz;- Band 27: 10000 Hz;- Band 28: 12500 Hz. | -| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Sharpness in acum. | +| **Pin 0**| output_sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types) | Sharpness in acum. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness_over_time.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness_over_time.md index 699695a34d..b6ff53a1d3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness_over_time.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sharpness_over_time.md @@ -17,20 +17,20 @@ Compute the sharpness over time of a signal, where sharpness is defined in accor | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute sharpness over time. | -| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | +| Pin 1| field_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Field type associated with the recording conditions (supported values: 'Free', 'Diffuse'). Default: 'Free'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| max_sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Maximum sharpness value over time, in acum. | +| **Pin 0**| max_sharpness |[`double`](../../core-concepts/dpf-types.md#standard-types) | Maximum sharpness value over time, in acum. | | **Pin 1**| sharpness_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Sharpness over time, in acum. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sound_power_level_iso3744.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sound_power_level_iso3744.md index 92c7fd9947..f615499977 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sound_power_level_iso3744.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_sound_power_level_iso3744.md @@ -16,20 +16,20 @@ Compute the sound power level (SWL) according to the ISO 3744 standard. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| surface_shape |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Shape of the measurement surface. Supported values are: 'Hemisphere', 'Half-hemisphere'. | -| Pin 1
Required| surface_radius |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Radius in meters of the hemisphere or half-hemisphere measurement surface. | -| Pin 2
Required| K1 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Background noise correction in dB (section 8.2.3 of ISO 3744). | -| Pin 3
Required| K2 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Environmental correction K2 in dB (Annex A of ISO 3744). | -| Pin 4
Required| C1 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Meteorological reference quantity correction C1 in dB (Annex G of ISO 3744). | -| Pin 5
Required| C2 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Meteorological radiation impedance correction C2 in dB (Annex G of ISO 3744). | +| Pin 0
Required| surface_shape |[`string`](../../core-concepts/dpf-types.md#standard-types) | Shape of the measurement surface. Supported values are: 'Hemisphere', 'Half-hemisphere'. | +| Pin 1
Required| surface_radius |[`double`](../../core-concepts/dpf-types.md#standard-types) | Radius in meters of the hemisphere or half-hemisphere measurement surface. | +| Pin 2
Required| K1 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Background noise correction in dB (section 8.2.3 of ISO 3744). | +| Pin 3
Required| K2 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Environmental correction K2 in dB (Annex A of ISO 3744). | +| Pin 4
Required| C1 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Meteorological reference quantity correction C1 in dB (Annex G of ISO 3744). | +| Pin 5
Required| C2 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Meteorological radiation impedance correction C2 in dB (Annex G of ISO 3744). | | Pin 6
Required| microphone_signals |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Signals recorded at various microphone positions on the measurement surface: each signal is stored as a field of microphone_signals. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| Lw |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Unweighted sound power level (Lw) in dB. | -| **Pin 1**| LwA |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | A-weighted sound power level (Lw(A)) in dBA. | +| **Pin 0**| Lw |[`double`](../../core-concepts/dpf-types.md#standard-types) | Unweighted sound power level (Lw) in dB. | +| **Pin 1**| LwA |[`double`](../../core-concepts/dpf-types.md#standard-types) | A-weighted sound power level (Lw(A)) in dBA. | | **Pin 2**| octave_band |[`field`](../../core-concepts/dpf-types.md#field) | Octave-band sound power levels, in dB. | | **Pin 3**| third_octave_band |[`field`](../../core-concepts/dpf-types.md#field) | One-third-octave-band sound power levels, in dB. | @@ -37,7 +37,7 @@ Compute the sound power level (SWL) according to the ISO 3744 standard. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_spectral_centroid.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_spectral_centroid.md index 8ceb0ea18d..94eb5ff12f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_spectral_centroid.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_spectral_centroid.md @@ -22,13 +22,13 @@ Compute the spectral centroid of a signal. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_spectral_centroid |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | The spectral centroid value in Hz. | +| **Pin 0**| output_spectral_centroid |[`double`](../../core-concepts/dpf-types.md#standard-types) | The spectral centroid value in Hz. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_stft.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_stft.md index 05428626b1..2cc6860831 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_stft.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_stft.md @@ -17,9 +17,9 @@ Compute Short-Time Fourier Transform (STFT) from a temporal signal. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | The input signal as a field on which to compute the STFT.
| -| Pin 1
Required| fft_size |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Size (as an integer) of the FFT to compute the STFT. Use a power of 2 for better performance.
| -| Pin 2| window_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | The window used for the FFT computation, as a string. Allowed input strings are: 'BLACKMAN', 'FLATTOP', 'GAUSS','HAMMING', 'HANN', 'RECTANGULAR', 'TRIANGULAR'. If no parameter is specified, the default value is 'HANN'. | -| Pin 3| window_overlap |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | The overlap value between two successive FFT computations (value between 0 and 1). 0 means no overlap, 0.5 means 50 % overlap. If no parameter is specified, default value is 0.5. | +| Pin 1
Required| fft_size |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Size (as an integer) of the FFT to compute the STFT. Use a power of 2 for better performance.
| +| Pin 2| window_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | The window used for the FFT computation, as a string. Allowed input strings are: 'BLACKMAN', 'FLATTOP', 'GAUSS','HAMMING', 'HANN', 'RECTANGULAR', 'TRIANGULAR'. If no parameter is specified, the default value is 'HANN'. | +| Pin 3| window_overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | The overlap value between two successive FFT computations (value between 0 and 1). 0 means no overlap, 0.5 means 50 % overlap. If no parameter is specified, default value is 0.5. | ## Outputs @@ -31,7 +31,7 @@ Compute Short-Time Fourier Transform (STFT) from a temporal signal. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_aures.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_aures.md index ac4ae53fae..d36a04fe19 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_aures.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_aures.md @@ -17,15 +17,15 @@ Compute the tonality of a signal, according to the Aures model (W. Aures, 'Proce | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the Aures tonality. | -| Pin 1| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Percentage in % of each window that overlaps with the next. Default: 90 %. | -| Pin 2| account_w1 |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Enable (True) or disable (False) the bandwidth weighting w1. Default: False. | -| Pin 3| bw_weighting_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Threshold in dB for the bandwidth weighting w1. The threshold value is ignored if input account_w1 is set to False. Default value: 3 dB. | +| Pin 1| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | Percentage in % of each window that overlaps with the next. Default: 90 %. | +| Pin 2| account_w1 |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Enable (True) or disable (False) the bandwidth weighting w1. Default: False. | +| Pin 3| bw_weighting_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | Threshold in dB for the bandwidth weighting w1. The threshold value is ignored if input account_w1 is set to False. Default value: 3 dB. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| tonality |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Overall tonality in tonality units (tu). | +| **Pin 0**| tonality |[`double`](../../core-concepts/dpf-types.md#standard-types) | Overall tonality in tonality units (tu). | | **Pin 1**| tonality_over_time_tu |[`field`](../../core-concepts/dpf-types.md#field) | Tonality over time in tu. | | **Pin 2**| wt_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonal component weighting wT over time.The tonal component weighting combines 3 weighting functions related to the bandwidth, the frequency, and the prominence of each detected tone. | | **Pin 3**| wGcr_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Relative loudness weighting wGr over time.The relative loudness weighting accounts for the relative contribution of the tonal loudness to the overall loudness. | @@ -34,7 +34,7 @@ Compute the tonality of a signal, according to the Aures model (W. Aures, 'Proce | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_din45681.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_din45681.md index 23cb7e5d83..da226265c3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_din45681.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_din45681.md @@ -17,16 +17,16 @@ Compute the tonality of a signal, according to the DIN 45681 standard. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the DIN 45681 tonality. | -| Pin 1| window_length |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Analysis window length in seconds. Default: 3 s. | -| Pin 2| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Percentage of each analysis window that overlaps with the next, in %. Default: 0 %. | +| Pin 1| window_length |[`double`](../../core-concepts/dpf-types.md#standard-types) | Analysis window length in seconds. Default: 3 s. | +| Pin 2| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | Percentage of each analysis window that overlaps with the next, in %. Default: 0 %. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_mean_difference_dl |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Tonality (mean difference DL) in dB. | -| **Pin 1**| output_mean_difference_uncertainty |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Tonality's uncertainty in dB. | -| **Pin 2**| output_tonal_adjustment_kt |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Tonal adjustment (Kt) in dB. | +| **Pin 0**| output_mean_difference_dl |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonality (mean difference DL) in dB. | +| **Pin 1**| output_mean_difference_uncertainty |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonality's uncertainty in dB. | +| **Pin 2**| output_tonal_adjustment_kt |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonal adjustment (Kt) in dB. | | **Pin 3**| output_decisive_difference_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonality over time (decisive difference over time DLj) in dB. | | **Pin 4**| output_decisive_difference_uncertainty_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonality's uncertainty over time in dB. | | **Pin 5**| output_decisive_frequency_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Decisive frequency over time in Hz. | @@ -37,7 +37,7 @@ Compute the tonality of a signal, according to the DIN 45681 standard. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_ecma418_2.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_ecma418_2.md index d5162e4158..658e0966e6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_ecma418_2.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_ecma418_2.md @@ -22,7 +22,7 @@ Compute the psychoacoustic tonality of a signal according to the ECMA 418-2 stan | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| tonality |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Psychoacoustic tonality in tuHMS. | +| **Pin 0**| tonality |[`double`](../../core-concepts/dpf-types.md#standard-types) | Psychoacoustic tonality in tuHMS. | | **Pin 1**| tonality_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Psychoacoustic tonality over time in tuHMS. | | **Pin 2**| tone_frequency_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Frequency of the most prominent tone over time, in Hz. | @@ -30,7 +30,7 @@ Compute the psychoacoustic tonality of a signal according to the ECMA 418-2 stan | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_iso1996_2.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_iso1996_2.md index 494c1b976e..e7518fb8ee 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_iso1996_2.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_iso1996_2.md @@ -17,23 +17,23 @@ Compute the tonal audibility and the tonal adjustment of a signal, according to | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the ISO 1996-2:2007 tonality. | -| Pin 1| noise_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Noise pause detection threshold (also referred to as level excess) in dB. Must be positive. Default: 1 dB. | -| Pin 2| effective_analysis_bw |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Effective analysis bandwidth in Hz. Must be in the range ]0, 5]. Default: 5 Hz. | -| Pin 3| noise_bandwidth |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Noise bandwidth, in proportion to the critical bandwidth, that is taken into account for the calculation of the masking noise level (the default value 0.75 means that the masking noise level is estimated in a band delimited by 75 % of the critical bandwidth on each side of the tone). Must be in the range [0.75, 2]. Default: 0.75. | +| Pin 1| noise_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | Noise pause detection threshold (also referred to as level excess) in dB. Must be positive. Default: 1 dB. | +| Pin 2| effective_analysis_bw |[`double`](../../core-concepts/dpf-types.md#standard-types) | Effective analysis bandwidth in Hz. Must be in the range ]0, 5]. Default: 5 Hz. | +| Pin 3| noise_bandwidth |[`double`](../../core-concepts/dpf-types.md#standard-types) | Noise bandwidth, in proportion to the critical bandwidth, that is taken into account for the calculation of the masking noise level (the default value 0.75 means that the masking noise level is estimated in a band delimited by 75 % of the critical bandwidth on each side of the tone). Must be in the range [0.75, 2]. Default: 0.75. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| tonality |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Tonal audibility, in dB. | -| **Pin 1**| tonal_adjustement |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Tonal adjustment Kt, in dB. | +| **Pin 0**| tonality |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonal audibility, in dB. | +| **Pin 1**| tonal_adjustement |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonal adjustment Kt, in dB. | | **Pin 2**| calculation_details |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | ISO 1996-2:2007 calculation details. The DataTree elements can be accessed, each as a double, using the following identifiers: - 'Tonal audibility (dB)'; - 'Tonal adjustement (dB)'; - 'Lower critical band limit (Hz)'; - 'Higher critical band limit (Hz)'; - 'Total noise level (dBA)'; - 'Total tonal level (dBA)'. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_iso1996_2_over_time.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_iso1996_2_over_time.md index 63ef340e50..4cfd5535dc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_iso1996_2_over_time.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_iso1996_2_over_time.md @@ -17,11 +17,11 @@ Compute the tonal audibility and tonal adjustment over time of a signal, where t | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the ISO 1996-2:2007 tonality over time. | -| Pin 1| window_length |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Analysis window length in ms. Default: 1000 ms. | -| Pin 2| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Percentage in % of each analysis window that overlaps with the next. Default: 75 %. | -| Pin 3| noise_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Noise pause detection threshold (also referred to as level excess) in dB. Must be positive. Default: 1 dB. | -| Pin 4| effective_analysis_bw |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Effective analysis bandwidth in Hz. Must be in the range ]0, 5]. Default: 5 Hz. | -| Pin 5| noise_bandwidth |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Noise bandwidth, in proportion to the critical bandwidth, that is taken into account for the calculation of the masking noise level (the default value 0.75 means that the masking noise level is estimated in a band delimited by 75 % of the critical bandwidth on each side of the tone). Must be in the range [0.75, 2]. Default: 0.75. | +| Pin 1| window_length |[`double`](../../core-concepts/dpf-types.md#standard-types) | Analysis window length in ms. Default: 1000 ms. | +| Pin 2| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | Percentage in % of each analysis window that overlaps with the next. Default: 75 %. | +| Pin 3| noise_threshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | Noise pause detection threshold (also referred to as level excess) in dB. Must be positive. Default: 1 dB. | +| Pin 4| effective_analysis_bw |[`double`](../../core-concepts/dpf-types.md#standard-types) | Effective analysis bandwidth in Hz. Must be in the range ]0, 5]. Default: 5 Hz. | +| Pin 5| noise_bandwidth |[`double`](../../core-concepts/dpf-types.md#standard-types) | Noise bandwidth, in proportion to the critical bandwidth, that is taken into account for the calculation of the masking noise level (the default value 0.75 means that the masking noise level is estimated in a band delimited by 75 % of the critical bandwidth on each side of the tone). Must be in the range [0.75, 2]. Default: 0.75. | ## Outputs @@ -35,7 +35,7 @@ Compute the tonal audibility and tonal adjustment over time of a signal, where t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_isots_20065.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_isots_20065.md index fc6afc8435..a3165f5f08 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_isots_20065.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tonality_isots_20065.md @@ -17,14 +17,14 @@ Computes tonality according to the ISO/TS 20065:2022 standard | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the tonality ISO/TS 20065:2022. | -| Pin 1| window_length |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Analysis window length in s. Default: 3. | -| Pin 2| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Percentage in % of each analysis window that overlaps with the next. Default: 0 %. | +| Pin 1| window_length |[`double`](../../core-concepts/dpf-types.md#standard-types) | Analysis window length in s. Default: 3. | +| Pin 2| overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | Percentage in % of each analysis window that overlaps with the next. Default: 0 %. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| output_mean_audibility_dl |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Tonality (mean audibility DL) in dB. | +| **Pin 0**| output_mean_audibility_dl |[`double`](../../core-concepts/dpf-types.md#standard-types) | Tonality (mean audibility DL) in dB. | | **Pin 1**| output_mean_audibility_uncertainty |[`field`](../../core-concepts/dpf-types.md#field) | Tonality's uncertainty in dB. | | **Pin 2**| output_decisive_audibility_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonality over time (decisive audibility over time DLj) in dB. | | **Pin 3**| output_decisive_audibility_uncertainty_over_time |[`field`](../../core-concepts/dpf-types.md#field) | Tonality's uncertainty over time in dB. | @@ -35,7 +35,7 @@ Computes tonality according to the ISO/TS 20065:2022 standard | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tone_to_noise_ratio_for_orders_over_time.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tone_to_noise_ratio_for_orders_over_time.md index cbebb40b6a..eb805c6127 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tone_to_noise_ratio_for_orders_over_time.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/compute_tone_to_noise_ratio_for_orders_over_time.md @@ -18,7 +18,7 @@ Compute the Tone-to-Noise Ratio (TNR) over time of a signal, for specific order( |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Input signal in Pa on which to compute the TNR over time for the specified orders. | | Pin 1
Required| rpm_profile |[`field`](../../core-concepts/dpf-types.md#field) | Profile of RPM over time associated with the input signal. Must have the same length and same sampling frequency as the input signal. | -| Pin 2
Required| orders_numbers |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | List of the order numbers for which to compute TNR. | +| Pin 2
Required| orders_numbers |[`vector`](../../core-concepts/dpf-types.md#standard-types) | List of the order numbers for which to compute TNR. | ## Outputs @@ -31,7 +31,7 @@ Compute the Tone-to-Noise Ratio (TNR) over time of a signal, for specific order( | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_field_from_vector.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_field_from_vector.md index 6d40041329..0d2735bd26 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_field_from_vector.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_field_from_vector.md @@ -16,9 +16,9 @@ Create a DPF field from a vector of samples. This field can then be used as a 's | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| in_data_vector |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Vector containing the signal's samples as double values. The first sample corresponds to time t = 0 s. | -| Pin 1
Required| in_sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Sampling frequency of the signal in Hz. | -| Pin 2
Required| in_unit |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Unit of the signal. | +| Pin 0
Required| in_data_vector |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Vector containing the signal's samples as double values. The first sample corresponds to time t = 0 s. | +| Pin 1
Required| in_sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | Sampling frequency of the signal in Hz. | +| Pin 2
Required| in_unit |[`string`](../../core-concepts/dpf-types.md#standard-types) | Unit of the signal. | ## Outputs @@ -30,7 +30,7 @@ Create a DPF field from a vector of samples. This field can then be used as a 's | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_noise_profile_from_automatic_estimation.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_noise_profile_from_automatic_estimation.md index 702cacd017..ed8093d860 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_noise_profile_from_automatic_estimation.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_noise_profile_from_automatic_estimation.md @@ -17,7 +17,7 @@ Automatic XTRACT noise profile estimation from a signal. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Signal (field) from which to estimate the noise profile. | -| Pin 1| window_length |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) Window length for the noise level estimation in ms. Default is 50 ms. | +| Pin 1| window_length |[`int32`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Window length for the noise level estimation in ms. Default is 50 ms. | ## Outputs @@ -29,7 +29,7 @@ Automatic XTRACT noise profile estimation from a signal. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_noise_profile_from_noise_samples.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_noise_profile_from_noise_samples.md index 8dcffedb67..220ee76c4a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_noise_profile_from_noise_samples.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_noise_profile_from_noise_samples.md @@ -17,8 +17,8 @@ Create a noise profile from an input signal which contains only noise. This prof | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`field`](../../core-concepts/dpf-types.md#field) | Signal (field) of noise. | -| Pin 1| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) Sampling frequency of the signal to denoise (which can be different from the signal used for creating the noise profile). Default is the sampling frequency of the noise signal. | -| Pin 2| window_length |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) Window length for the noise level estimation in ms. Default value is 50 ms. | +| Pin 1| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the signal to denoise (which can be different from the signal used for creating the noise profile). Default is the sampling frequency of the noise signal. | +| Pin 2| window_length |[`int32`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Window length for the noise level estimation in ms. Default value is 50 ms. | ## Outputs @@ -30,7 +30,7 @@ Create a noise profile from an input signal which contains only noise. This prof | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_noise_profile_from_white_noise_power.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_noise_profile_from_white_noise_power.md index 538f612a72..c17236c36e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_noise_profile_from_white_noise_power.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/create_noise_profile_from_white_noise_power.md @@ -16,9 +16,9 @@ Create a noise profile for XTRACT, given the power level of the white noise. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_white_noise_power |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Power of the white noise (dB SPL). | -| Pin 1
Required| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Sampling frequency of the signal to denoise (which can be different from the signal used for creating the noise profile). | -| Pin 2| window_length |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) Window length for the noise level estimation in ms. Default is 50 ms. | +| Pin 0
Required| input_white_noise_power |[`double`](../../core-concepts/dpf-types.md#standard-types) | Power of the white noise (dB SPL). | +| Pin 1
Required| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | Sampling frequency of the signal to denoise (which can be different from the signal used for creating the noise profile). | +| Pin 2| window_length |[`int32`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Window length for the noise level estimation in ms. Default is 50 ms. | ## Outputs @@ -30,7 +30,7 @@ Create a noise profile for XTRACT, given the power level of the white noise. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/filter_design_minimum_phase_FIR_filter_from_FRF.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/filter_design_minimum_phase_FIR_filter_from_FRF.md index cf2b8451f4..0be71ac374 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/filter_design_minimum_phase_FIR_filter_from_FRF.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/filter_design_minimum_phase_FIR_filter_from_FRF.md @@ -17,20 +17,20 @@ Design a minimum-phase Finite Impulse Response (FIR) filter from a Frequency Res | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| frequency_response_function |[`field`](../../core-concepts/dpf-types.md#field) | Frequency response function (FRF) from which to design the minimum-phase filter. The FRF is expected as a field which contains the gain in dB for each frequency. The frequencies are specified as the time support of the field. | -| Pin 1| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) Sampling frequency of the coefficients of the returned minimum-phase filter. If no value is specified, the sampling frequency is set to 2 * maximum frequency of the input FRF. | +| Pin 1| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the coefficients of the returned minimum-phase filter. If no value is specified, the sampling frequency is set to 2 * maximum frequency of the input FRF. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| filter_b_coefficients |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Coefficients B of the minimum-phase FIR filter designed from the input FRF. | -| **Pin 1**| filter_a_coefficients |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) Coefficient A of the minimum-phase FIR filter designed from the input FRF. Note: as it is a FIR filter, A is always filled with the single value 1.0. | +| **Pin 0**| filter_b_coefficients |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Coefficients B of the minimum-phase FIR filter designed from the input FRF. | +| **Pin 1**| filter_a_coefficients |[`vector`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Coefficient A of the minimum-phase FIR filter designed from the input FRF. Note: as it is a FIR filter, A is always filled with the single value 1.0. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/filter_signal.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/filter_signal.md index 296db87295..a1d13d0c7c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/filter_signal.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/filter_signal.md @@ -17,8 +17,8 @@ Filters a 1D signal, using a linear, time-invariant digital filter. The filter i | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| signal_to_filter |[`field`](../../core-concepts/dpf-types.md#field) | Signal to filter. | -| Pin 1
Required| filter_b_coefficients |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Coefficients B of the filter. | -| Pin 2| filter_a_coefficients |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) Coefficients A of the filter. | +| Pin 1
Required| filter_b_coefficients |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Coefficients B of the filter. | +| Pin 2| filter_a_coefficients |[`vector`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Coefficients A of the filter. | ## Outputs @@ -30,7 +30,7 @@ Filters a 1D signal, using a linear, time-invariant digital filter. The filter i | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/get_cropped_signal.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/get_cropped_signal.md index 8221a38261..9e4df82cf3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/get_cropped_signal.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/get_cropped_signal.md @@ -17,8 +17,8 @@ Crop is used to isolate a part of a signal between a start and end time. Note: C | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| input_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | The input signal. | -| Pin 1
Required| start_time_in_sec |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Start time of the part to crop, in seconds. | -| Pin 2
Required| end_time_in_sec |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | End time of the part to crop, in seconds. | +| Pin 1
Required| start_time_in_sec |[`double`](../../core-concepts/dpf-types.md#standard-types) | Start time of the part to crop, in seconds. | +| Pin 2
Required| end_time_in_sec |[`double`](../../core-concepts/dpf-types.md#standard-types) | End time of the part to crop, in seconds. | ## Outputs @@ -30,7 +30,7 @@ Crop is used to isolate a part of a signal between a start and end time. Note: C | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/isolate_orders.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/isolate_orders.md index 02d1e2f3d9..072c716653 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/isolate_orders.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/isolate_orders.md @@ -22,10 +22,10 @@ Isolate orders in a signal. This operator allows you to select the orders of a h | Pin 0
Required| input_time_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | The input signal(s) as a fields container or a field on which to isolate orders.
| | Pin 1
Required| input_rpm_signal |[`field`](../../core-concepts/dpf-types.md#field) | The RPM signal associated with the time signals, as a field. It is assumed that the signal's unit is 'RPM'. If this is not the case, inaccurate behavior might occur during the conversion from RPM to frequency. | | Pin 2
Required| orders_to_extract |[`field`](../../core-concepts/dpf-types.md#field) | List of the order numbers you want to isolate. Must contain at least one value.
| -| Pin 3
Required| fft_size |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Size (as an integer) of the FFT used to compute the STFT. Use a power of 2 for better performance.
| -| Pin 4| window_type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | The window used for the FFT computation, as a string. Allowed input strings are: 'BLACKMAN', 'FLATTOP', 'GAUSS','HAMMING', 'HANN', 'RECTANGULAR', 'TRIANGULAR'. If no parameter is specified, the default value is 'HANN'. | -| Pin 5| window_overlap |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | The overlap value for FFT computation (float value between 0 and 1). If no parameter is specified, the default value is 0.5.
| -| Pin 6| width_order_selection |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | The width, in Hz, of the area used to select each individual order. This area is centered on each order. Note that its precision depends on the FFT size selected in pin 3. If no parameter is specified, the default value is 10 Hz.
| +| Pin 3
Required| fft_size |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Size (as an integer) of the FFT used to compute the STFT. Use a power of 2 for better performance.
| +| Pin 4| window_type |[`string`](../../core-concepts/dpf-types.md#standard-types) | The window used for the FFT computation, as a string. Allowed input strings are: 'BLACKMAN', 'FLATTOP', 'GAUSS','HAMMING', 'HANN', 'RECTANGULAR', 'TRIANGULAR'. If no parameter is specified, the default value is 'HANN'. | +| Pin 5| window_overlap |[`double`](../../core-concepts/dpf-types.md#standard-types) | The overlap value for FFT computation (float value between 0 and 1). If no parameter is specified, the default value is 0.5.
| +| Pin 6| width_order_selection |[`int32`](../../core-concepts/dpf-types.md#standard-types) | The width, in Hz, of the area used to select each individual order. This area is centered on each order. Note that its precision depends on the FFT size selected in pin 3. If no parameter is specified, the default value is 10 Hz.
| ## Outputs @@ -38,7 +38,7 @@ Isolate orders in a signal. This operator allows you to select the orders of a h | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_FRF_from_txt.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_FRF_from_txt.md index d8f81ece7c..870eea94fc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_FRF_from_txt.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_FRF_from_txt.md @@ -16,7 +16,7 @@ Loads a Frequency Response Function (FRF) from a text file. The supported files | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Path to the text file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the text file. | ## Outputs @@ -28,7 +28,7 @@ Loads a Frequency Response Function (FRF) from a text file. The supported files | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_project_sound_power_level_iso3744.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_project_sound_power_level_iso3744.md index 4b4d12dd4a..af2e6d88e2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_project_sound_power_level_iso3744.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_project_sound_power_level_iso3744.md @@ -16,25 +16,25 @@ Load a sound power level project file (*.spw), created with Sound SAS. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| project_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Path to the sound power level project file. | +| Pin 0
Required| project_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the sound power level project file. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| surface_shape |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Shape of the measurement surface ('Hemisphere', 'Half-hemisphere')'. | -| **Pin 1**| surface_radius |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Radius in meters of the hemisphere or half-hemisphere measurement surface. | -| **Pin 2**| K1 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Background noise correction in dB (section 8.2.3 of ISO 3744). | -| **Pin 3**| K2 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Environmental correction K2 in dB (Annex A of ISO 3744). | -| **Pin 4**| C1 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Meteorological reference quantity correction C1 in dB (Annex G of ISO 3744). | -| **Pin 5**| C2 |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Meteorological radiation impedance correction C2 in dB (Annex G of ISO 3744). | +| **Pin 0**| surface_shape |[`string`](../../core-concepts/dpf-types.md#standard-types) | Shape of the measurement surface ('Hemisphere', 'Half-hemisphere')'. | +| **Pin 1**| surface_radius |[`double`](../../core-concepts/dpf-types.md#standard-types) | Radius in meters of the hemisphere or half-hemisphere measurement surface. | +| **Pin 2**| K1 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Background noise correction in dB (section 8.2.3 of ISO 3744). | +| **Pin 3**| K2 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Environmental correction K2 in dB (Annex A of ISO 3744). | +| **Pin 4**| C1 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Meteorological reference quantity correction C1 in dB (Annex G of ISO 3744). | +| **Pin 5**| C2 |[`double`](../../core-concepts/dpf-types.md#standard-types) | Meteorological radiation impedance correction C2 in dB (Annex G of ISO 3744). | | **Pin 6**| microphone_signals |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Signals recorded at various microphone positions on the measurement surface: each signal is stored as a field of microphone_signals. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_sound_samples_from_txt.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_sound_samples_from_txt.md index ffe8870445..8a58c71f1b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_sound_samples_from_txt.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_sound_samples_from_txt.md @@ -16,7 +16,7 @@ Return a signal (in a field) created with the samples vs time loaded from a txt | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Path to text file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to text file. | ## Outputs @@ -28,7 +28,7 @@ Return a signal (in a field) created with the samples vs time loaded from a txt | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_wav_sas.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_wav_sas.md index 66cd985f91..a45e106ebf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_wav_sas.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/load_wav_sas.md @@ -28,7 +28,7 @@ Read a wav file created by Ansys Sound SAS, and store the signal(s) in a fields_ | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/resample.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/resample.md index f5467813fa..f0663bc48d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/resample.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/resample.md @@ -17,7 +17,7 @@ Resample a signal to a target sampling frequency. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| signal_to_resample |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Input signal(s) to resample, as a fields_container. Each signal (stored as a field) is resampled. | -| Pin 1
Required| target_fs |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Target sampling frequency, in Hz. | +| Pin 1
Required| target_fs |[`double`](../../core-concepts/dpf-types.md#standard-types) | Target sampling frequency, in Hz. | ## Outputs @@ -29,7 +29,7 @@ Resample a signal to a target sampling frequency. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_bbn.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_bbn.md index 4a1abb688d..99acf93bd6 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_bbn.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_bbn.md @@ -18,7 +18,7 @@ Generate a sound from a broadband noise model (1 parameter), according to a give |-------|-------|------------------|-------------| | Pin 0
Required| source_bbn |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Broadband noise model (1 parameter), as a fields container. Each field contains the level vs frequency of the noise at a given value of the control parameter. Level vs frequency may be specified as a Power Spectral Density (PSD) in Pa^2/Hz, or as Octave bands level in Pa^2, or as 1/3 Octave bands level in Pa^2. The unit must be indicated in the field's unit. The type of data (PSD, Octave, 1/3 octave) must be indicated in the field's FieldDefinition attribute, as a quantity_type. | | Pin 1
Required| control |[`field`](../../core-concepts/dpf-types.md#field) | Control parameter value vs time, as a field. | -| Pin 2| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) Sampling frequency of the generated sound, in Hz. Default: 44100 Hz. | +| Pin 2| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the generated sound, in Hz. Default: 44100 Hz. | ## Outputs @@ -30,7 +30,7 @@ Generate a sound from a broadband noise model (1 parameter), according to a give | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_bbn_two_parameters.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_bbn_two_parameters.md index 322827ce53..534a5a28ae 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_bbn_two_parameters.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_bbn_two_parameters.md @@ -19,7 +19,7 @@ Generate a sound from a broadband noise model (2 parameters), according to a giv | Pin 0
Required| source_bbn_two_parameters |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Broadband noise model (2 parameters), as a fields container. This fields container is obtained as the output of the operator 'sound_composer_load_source_bbn_two_parameters'. | | Pin 1
Required| control_1 |[`field`](../../core-concepts/dpf-types.md#field) | First control parameter value vs time, as a field. | | Pin 2
Required| control_2 |[`field`](../../core-concepts/dpf-types.md#field) | Second control parameter value vs time, as a field. | -| Pin 3| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) Sampling frequency of the generated sound, in Hz. Default: 44100 Hz. | +| Pin 3| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the generated sound, in Hz. Default: 44100 Hz. | ## Outputs @@ -31,7 +31,7 @@ Generate a sound from a broadband noise model (2 parameters), according to a giv | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_harmonics.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_harmonics.md index aaaa6d3264..d4072adc6b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_harmonics.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_harmonics.md @@ -18,7 +18,7 @@ Generate a sound from a harmonics (1 parameter) model, according to a given evol |-------|-------|------------------|-------------| | Pin 0
Required| source_harmonics |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Harmonics (1 parameter) model, as a fields container. Each field contains the level of all orders (the harmonics), at a corresponding RPM value (control parameter). Each field contains the same number of orders, each with the same order numbers, as in the other fields of source_harmonics. The order numbers are stored in the time-frequency support of the field. The control parameter (RPM) vector is stored as the support of the fields container. Levels must be provided in Pa^2. The unit must be specified in each field's unit. | | Pin 1
Required| rpm_control |[`field`](../../core-concepts/dpf-types.md#field) | RPM value vs time, as a field. | -| Pin 2| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) Sampling frequency of the generated sound, in Hz. Default: 44100 Hz | +| Pin 2| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the generated sound, in Hz. Default: 44100 Hz | ## Outputs @@ -30,7 +30,7 @@ Generate a sound from a harmonics (1 parameter) model, according to a given evol | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_harmonics_two_parameters.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_harmonics_two_parameters.md index 591c2a0a28..fc3a3563bf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_harmonics_two_parameters.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_harmonics_two_parameters.md @@ -19,7 +19,7 @@ Generate a sound from a Harmonic (2 parameters) model and the evolution of two c | Pin 0
Required| source_bbn |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Harmonic (2 parameters), as a fields container. Each field contains the level vs orders of the model at a given RPM and control parameter value. Levels must be specified in Pa^2. The unit must be indicated in the field's unit. | | Pin 1
Required| rpm_control |[`field`](../../core-concepts/dpf-types.md#field) | RPM value vs time, as a field. | | Pin 2
Required| control_2 |[`field`](../../core-concepts/dpf-types.md#field) | Second control parameter value vs time, as a field. | -| Pin 3| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) Sampling frequency of the output generated sound, in Hz. Default: 44100 Hz. | +| Pin 3| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency of the output generated sound, in Hz. Default: 44100 Hz. | ## Outputs @@ -31,7 +31,7 @@ Generate a sound from a Harmonic (2 parameters) model and the evolution of two c | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_spectrum.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_spectrum.md index 364bac8775..50f8f55c35 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_spectrum.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_generate_sound_spectrum.md @@ -17,9 +17,9 @@ Generate a sound from a spectrum (as a Field), given the duration and the method | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| source_spectrum |[`field`](../../core-concepts/dpf-types.md#field) | Spectrum, as a Field, from which the sound is generated. The expected unit of this spectrum is Pa^2/Hz. | -| Pin 1
Required| duration |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Duration in seconds of the generated sound. | -| Pin 2
Required| method |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Method to use for the sound generation. Supported input strings are: 'IFFT', 'Hybrid'. | -| Pin 3| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | (Optional) Sampling frequency in Hz of the generated sound. Default: 44100 Hz. | +| Pin 1
Required| duration |[`double`](../../core-concepts/dpf-types.md#standard-types) | Duration in seconds of the generated sound. | +| Pin 2
Required| method |[`string`](../../core-concepts/dpf-types.md#standard-types) | Method to use for the sound generation. Supported input strings are: 'IFFT', 'Hybrid'. | +| Pin 3| sampling_frequency |[`double`](../../core-concepts/dpf-types.md#standard-types) | (Optional) Sampling frequency in Hz of the generated sound. Default: 44100 Hz. | ## Outputs @@ -31,7 +31,7 @@ Generate a sound from a spectrum (as a Field), given the duration and the method | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_project.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_project.md index ebd72b93f1..0f52a3ffdd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_project.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_project.md @@ -16,20 +16,20 @@ Load a Sound Composer project from a .scn file. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Path to the project file to load. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the project file to load. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| | **Pin 0**| sound_composer_project |[`any_collection`](../../core-concepts/dpf-types.md#any-collection) | DPF object that contains the loaded Sound Composer project. | -| **Pin 1**| sound_composer_project_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Name of the loaded Sound Composer project. | +| **Pin 1**| sound_composer_project_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Name of the loaded Sound Composer project. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_bbn.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_bbn.md index a16592c683..e08b801285 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_bbn.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_bbn.md @@ -16,7 +16,7 @@ Load a broadband noise (BBN) model (1 parameter) from a file. Supported files ar | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Path to the broadband noise (1 parameter) file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the broadband noise (1 parameter) file. | ## Outputs @@ -28,7 +28,7 @@ Load a broadband noise (BBN) model (1 parameter) from a file. Supported files ar | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_bbn_two_parameters.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_bbn_two_parameters.md index 70e9df8da8..681cae6307 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_bbn_two_parameters.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_bbn_two_parameters.md @@ -16,7 +16,7 @@ Load a broadband noise (BBN) model (2 parameters) from a file. Supported files a | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Path to the broadband noise (2 parameters) file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the broadband noise (2 parameters) file. | ## Outputs @@ -28,7 +28,7 @@ Load a broadband noise (BBN) model (2 parameters) from a file. Supported files a | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_harmonics.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_harmonics.md index 64d8ccc85e..d02a613249 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_harmonics.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_harmonics.md @@ -16,7 +16,7 @@ Load a harmonics (1 parameter) model from a file. Supported files are text files | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Path to the harmonics (1 parameter) file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the harmonics (1 parameter) file. | ## Outputs @@ -28,7 +28,7 @@ Load a harmonics (1 parameter) model from a file. Supported files are text files | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_harmonics_two_parameters.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_harmonics_two_parameters.md index 660654c1f7..70fd0804de 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_harmonics_two_parameters.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_harmonics_two_parameters.md @@ -16,7 +16,7 @@ Load a Harmonics (2 parameters) source from a file. Supported files are text fil | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Path to the harmonics (2 parameters) source file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the harmonics (2 parameters) source file. | ## Outputs @@ -28,7 +28,7 @@ Load a Harmonics (2 parameters) source from a file. Supported files are text fil | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_spectrum.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_spectrum.md index 58091e245f..62d3d233ca 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_spectrum.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_load_source_spectrum.md @@ -16,7 +16,7 @@ Load a source of type Spectrum from a file. Supported files are XML files and te | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Path to the spectrum source file. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the spectrum source file. | ## Outputs @@ -28,7 +28,7 @@ Load a source of type Spectrum from a file. Supported files are XML files and te | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_save_project.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_save_project.md index da9e68655a..6b25b8fcc0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_save_project.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sound_composer_save_project.md @@ -16,9 +16,9 @@ Save a Sound Composer project in a .scn file. This file can be opened in Ansys S | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Path to the file to save. | +| Pin 0
Required| file_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the file to save. | | Pin 1
Required| sound_composer_project |[`any_collection`](../../core-concepts/dpf-types.md#any-collection) | DPF object that contains the Sound Composer project to save. | -| Pin 2
Required| sound_composer_project_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Name of the Sound Composer project to save. | +| Pin 2
Required| sound_composer_project_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Name of the Sound Composer project to save. | ## Outputs @@ -29,7 +29,7 @@ Save a Sound Composer project in a .scn file. This file can be opened in Ansys S | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sum_signals.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sum_signals.md index c7259161c3..05f1950c27 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/sum_signals.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/sum_signals.md @@ -28,7 +28,7 @@ Sample-by-sample sum of all the signals (fields) of an input fields_container, i | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/write_wav_sas.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/write_wav_sas.md index 27f07e07e4..22a56d18f5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/write_wav_sas.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/write_wav_sas.md @@ -18,7 +18,7 @@ Writes signal(s) (fields_container) to a wav file (Ansys Sound SAS wav format). |-------|-------|------------------|-------------| | Pin 0
Required| in_multi_channel_signal |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | Signal to save: fields_container with each channel as a field. | | Pin 1
Required| out_path_and_file_name |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | Path of the wav file to save. | -| Pin 2
Required| type |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Bit depth. Supported values are: 'float32', 'int32', 'int16', 'int8'.
This means that the samples will be respectively coded into the wav file using 32 bits (32-bit IEEE Float), 32 bits (int), 16 bits (int) or 8 bits (int). | +| Pin 2
Required| type |[`string`](../../core-concepts/dpf-types.md#standard-types) | Bit depth. Supported values are: 'float32', 'int32', 'int16', 'int8'.
This means that the samples will be respectively coded into the wav file using 32 bits (32-bit IEEE Float), 32 bits (int), 16 bits (int) or 8 bits (int). | ## Outputs @@ -29,7 +29,7 @@ Writes signal(s) (fields_container) to a wav file (Ansys Sound SAS wav format). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract.md index 3b657297c9..55361c57ea 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract.md @@ -34,7 +34,7 @@ XTRACT processing: in the same way as in Sound SAS, this operator chains a denoi | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract_denoiser.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract_denoiser.md index b8ec6af0d2..2d47d33682 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract_denoiser.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract_denoiser.md @@ -30,7 +30,7 @@ Signal denoising using the XTRACT algorithm. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract_tonal.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract_tonal.md index 60e6e4d47d..f743aa8212 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract_tonal.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract_tonal.md @@ -30,7 +30,7 @@ Tonal components detection and isolation, using the XTRACT algorithm. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract_transient.md b/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract_transient.md index 3f72810ed4..92963f78da 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract_transient.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/sound/xtract_transient.md @@ -30,7 +30,7 @@ Transient components detection and extraction using the XTRACT algorithm. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_matrices.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_matrices.md index d075dedf0b..029ddf75c9 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_matrices.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_matrices.md @@ -25,7 +25,7 @@ Take nine scalar fields and assemble them as a 3x3 matrix field. If the 'symmetr | Pin 6| yx |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 7| zy |[`field`](../../core-concepts/dpf-types.md#field) | | | Pin 8| zx |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 60| symmetrical |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 60| symmetrical |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -37,7 +37,7 @@ Take nine scalar fields and assemble them as a 3x3 matrix field. If the 'symmetr | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_matrices_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_matrices_fc.md index 4e092171c2..6ecad33735 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_matrices_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_matrices_fc.md @@ -25,7 +25,7 @@ Take nine scalar fields container and assemble them as a 3x3 matrix fields. If t | Pin 6| yx |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 7| zy |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | | Pin 8| zx |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 60| symmetrical |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 60| symmetrical |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -37,7 +37,7 @@ Take nine scalar fields container and assemble them as a 3x3 matrix fields. If t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_vectors.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_vectors.md index 519429b0a0..1a316cd5a8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_vectors.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_vectors.md @@ -30,7 +30,7 @@ Takes three scalar fields and assembles them as a 3D vector field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_vectors_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_vectors_fc.md index bcbbb6aedf..88c005649d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_vectors_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/assemble_scalars_to_vectors_fc.md @@ -30,7 +30,7 @@ Takes three scalar fields container and assembles them as a 3D vector fields con | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/bind_support.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/bind_support.md index 8327929f45..c4d774c4f3 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/bind_support.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/bind_support.md @@ -29,7 +29,7 @@ Ties a support to a field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/bind_support_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/bind_support_fc.md index a8422d3220..152b7cbb55 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/bind_support_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/bind_support_fc.md @@ -29,7 +29,7 @@ Ties a support to a fields container. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/change_location.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/change_location.md index d3ed48724b..292cb0e881 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/change_location.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/change_location.md @@ -17,7 +17,7 @@ change the location of a field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| new_location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | new location of the output field ex 'Nodal', 'ElementalNodal', 'Elemental'... | +| Pin 1
Required| new_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | new location of the output field ex 'Nodal', 'ElementalNodal', 'Elemental'... | ## Outputs @@ -29,7 +29,7 @@ change the location of a field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/change_shell_layers.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/change_shell_layers.md index 513bed1fc3..d07cae0920 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/change_shell_layers.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/change_shell_layers.md @@ -17,9 +17,9 @@ Extract the requested shell layers from the input fields. If the fields contain | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| e_shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), enum dataProcessing::EShellLayers | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. | +| Pin 1
Required| e_shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types), enum dataProcessing::EShellLayers | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. | | Pin 2| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | Mesh support of the input fields_container, in case it does not have one defined. If the fields_container contains mixed shell/solid results, the mesh is required (either by connecting this pin or in the support). | -| Pin 26| merge |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | For fields with mixed shell layers (solid/shell elements with heterogeneous shell layers), group all of them in the same field (false by default). | +| Pin 26| merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For fields with mixed shell layers (solid/shell elements with heterogeneous shell layers), group all of them in the same field (false by default). | ## Outputs @@ -31,8 +31,8 @@ Extract the requested shell layers from the input fields. If the fields contain | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | If permissive is set to false, the operator run will ensure the 'change shell layers' operation is allowed (for example, if asking mid layer for a field defined on top and bottom layers, the computed field will be empty). If permissive is set to true, the operator run will be done in a permissive way (no check). Default is true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | If permissive is set to false, the operator run will ensure the 'change shell layers' operation is allowed (for example, if asking mid layer for a field defined on top and bottom layers, the computed field will be empty). If permissive is set to true, the operator run will be done in a permissive way (no check). Default is true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/compute_time_scoping.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/compute_time_scoping.md index a674946111..5177fa6caf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/compute_time_scoping.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/compute_time_scoping.md @@ -16,9 +16,9 @@ Computes the time frequency scoping (made of set IDs) necessary to interpolate o | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| time_freq_values |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`field`](../../core-concepts/dpf-types.md#field), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | List of frequencies or times needed. To specify load steps, put a field (and not a list) in input with a scoping located on "TimeFreq_steps". | -| Pin 2| step |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 4| interpolation_type |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 1:ramped' or 2:stepped', default is ramped | +| Pin 0
Required| time_freq_values |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | List of frequencies or times needed. To specify load steps, put a field (and not a list) in input with a scoping located on "TimeFreq_steps". | +| Pin 2| step |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 4| interpolation_type |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 1:ramped' or 2:stepped', default is ramped | | Pin 8
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | ## Outputs @@ -32,7 +32,7 @@ Computes the time frequency scoping (made of set IDs) necessary to interpolate o | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/default_value.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/default_value.md index 37e08798c5..8be6429ad4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/default_value.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/default_value.md @@ -29,7 +29,7 @@ Default return value from input pin 1 to output pin 0 if there is nothing on inp | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/delegate_to_operator.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/delegate_to_operator.md index b497483c24..1820c58899 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/delegate_to_operator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/delegate_to_operator.md @@ -16,7 +16,7 @@ Delegate the run to an Operator instantiated by the name in input (forwards all | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1
Required| operator_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin -1
Required| operator_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -28,7 +28,7 @@ Delegate the run to an Operator instantiated by the name in input (forwards all | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/ds_get_attribute.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/ds_get_attribute.md index 49132d22f4..afed262699 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/ds_get_attribute.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/ds_get_attribute.md @@ -17,22 +17,22 @@ A DataSources in pin 0 and a property name (string) in pin 1 are expected in inp | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | -| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Accepted inputs are: 'file_path' (returns string), 'result_file_name' (returns string), 'domain_file_path' (returns string), 'domain_result_file_name' (returns string), 'num_keys' (returns int), num_result_key (returns int), num_file_path (returns int), 'num_result_file_path' (returns int), 'key_by_index' (returns string), 'result_key_by_index' (returns string), 'path_by_index' (returns string), 'path_key_by_index' (returns string). | -| Pin 2| property_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Index for the property. Must be set for 'domain_file_path', 'domain_result_file_name' 'key_by_index', 'result_key_by_index', 'path_by_index' and 'path_key_by_index' properties. | -| Pin 3| property_key |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Key to look for. Must be set for 'file_path' and 'domain_file_path' properties. | -| Pin 4| property_result_key |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Result key to look for. Can be used for 'file_path', 'result_file_name', 'domain_file_path' and 'domain_result_file_name'. | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Accepted inputs are: 'file_path' (returns string), 'result_file_name' (returns string), 'domain_file_path' (returns string), 'domain_result_file_name' (returns string), 'num_keys' (returns int), num_result_key (returns int), num_file_path (returns int), 'num_result_file_path' (returns int), 'key_by_index' (returns string), 'result_key_by_index' (returns string), 'path_by_index' (returns string), 'path_key_by_index' (returns string). | +| Pin 2| property_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Index for the property. Must be set for 'domain_file_path', 'domain_result_file_name' 'key_by_index', 'result_key_by_index', 'path_by_index' and 'path_key_by_index' properties. | +| Pin 3| property_key |[`string`](../../core-concepts/dpf-types.md#standard-types) | Key to look for. Must be set for 'file_path' and 'domain_file_path' properties. | +| Pin 4| property_result_key |[`string`](../../core-concepts/dpf-types.md#standard-types) | Result key to look for. Can be used for 'file_path', 'result_file_name', 'domain_file_path' and 'domain_result_file_name'. | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Property value. | +| **Pin 0**| property |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Property value. | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_field.md index c4cc1779de..df83927995 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_field.md @@ -17,7 +17,7 @@ Extracts the fields at the indices defined in the vector (in 1) from the fields | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | if a field is in input, it is passed on as an output | -| Pin 1| indices |[`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Default is the first field | +| Pin 1| indices |[`vector`](../../core-concepts/dpf-types.md#standard-types) | Default is the first field | ## Outputs @@ -29,7 +29,7 @@ Extracts the fields at the indices defined in the vector (in 1) from the fields | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_scoping.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_scoping.md index 162dcba2ba..5b955b1544 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_scoping.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_scoping.md @@ -28,7 +28,7 @@ Takes a field or a fields container and extracts its scoping or scopings contain | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_sub_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_sub_fc.md index 4fdb55908e..0ced0b99f2 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_sub_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_sub_fc.md @@ -18,7 +18,7 @@ Creates a new fields container with all the fields corresponding to the label sp |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields_container | | Pin 1| label_space |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Label space, or scoping defining the label space (scoping location), values to keep (scoping IDs) | -| Pin 2| collapse_labels |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If set to true (default) the input label space (scoping location) is suppressed from the output fields container, otherwise, label space is kept. | +| Pin 2| collapse_labels |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If set to true (default) the input label space (scoping location) is suppressed from the output fields container, otherwise, label space is kept. | ## Outputs @@ -30,7 +30,7 @@ Creates a new fields container with all the fields corresponding to the label sp | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_sub_mc.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_sub_mc.md index 57a2888b7d..71998fdd3a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_sub_mc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_sub_mc.md @@ -18,7 +18,7 @@ Creates a new meshes container with all the meshed regions corresponding to the |-------|-------|------------------|-------------| | Pin 0
Required| meshes |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | meshes | | Pin 1| label_space |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Label space, or scoping defining the label space (scoping location), values to keep (scoping IDs) | -| Pin 2| collapse_labels |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If set to true (default) the input label space (scoping location) is suppressed from the output meshes container, otherwise, label space is kept. | +| Pin 2| collapse_labels |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If set to true (default) the input label space (scoping location) is suppressed from the output meshes container, otherwise, label space is kept. | ## Outputs @@ -30,7 +30,7 @@ Creates a new meshes container with all the meshed regions corresponding to the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_sub_sc.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_sub_sc.md index 19869e01b8..db2226d95a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_sub_sc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_sub_sc.md @@ -18,7 +18,7 @@ Creates a new scopings container with all the scopings corresponding to the labe |-------|-------|------------------|-------------| | Pin 0
Required| scopings_container |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | scopings_container | | Pin 1| label_space |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Label space, or scoping defining the label space (scoping location), values to keep (scoping IDs) | -| Pin 2| collapse_labels |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If set to true (default) the input label space (scoping location) is suppressed from the output scopings container, otherwise, label space is kept. | +| Pin 2| collapse_labels |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If set to true (default) the input label space (scoping location) is suppressed from the output scopings container, otherwise, label space is kept. | ## Outputs @@ -30,7 +30,7 @@ Creates a new scopings container with all the scopings corresponding to the labe | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_time_freq.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_time_freq.md index 9200f290f1..d62466813b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_time_freq.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/extract_time_freq.md @@ -18,7 +18,7 @@ Extract timefreqs with sets scoping from a time freq support |-------|-------|------------------|-------------| | Pin 0
Required| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | | | Pin 1| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 2| real_or_complex |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | False for real only (default). True for complex output. | +| Pin 2| real_or_complex |[`bool`](../../core-concepts/dpf-types.md#standard-types) | False for real only (default). True for complex output. | ## Outputs @@ -30,7 +30,7 @@ Extract timefreqs with sets scoping from a time freq support | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/fc_get_attribute.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/fc_get_attribute.md index 42fd3f88bb..dbc6b66bbb 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/fc_get_attribute.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/fc_get_attribute.md @@ -17,20 +17,20 @@ Uses the FieldsContainer APIs to return a given attribute of the fields containe | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Supported property names are: "label_scoping", "label_values", "time_freq_support", "labels", "field_scoping" and "field". | -| Pin 2| property_identifier |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Additional pin for some property : the label name for "label_scoping" or "label_values", the field index (default 0) for "field_scoping" or "field". | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "label_scoping", "label_values", "time_freq_support", "labels", "field_scoping" and "field". | +| Pin 2| property_identifier |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Additional pin for some property : the label name for "label_scoping" or "label_values", the field index (default 0) for "field_scoping" or "field". | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| property |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`label_space`](../../core-concepts/dpf-types.md#label-space), [`field`](../../core-concepts/dpf-types.md#field) | Returns a Scoping for property: "label_scoping", a vector of int for "label_values", a time freq support for "time_freq_support", a vector of string for "labels", a LabelSpace for "field_scoping" and a "field" for "field". | +| **Pin 0**| property |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`label_space`](../../core-concepts/dpf-types.md#label-space), [`field`](../../core-concepts/dpf-types.md#field) | Returns a Scoping for property: "label_scoping", a vector of int for "label_values", a time freq support for "time_freq_support", a vector of string for "labels", a LabelSpace for "field_scoping" and a "field" for "field". | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/field_clone_to_shell_layer.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/field_clone_to_shell_layer.md index ccd6909ece..cbc3b39bb0 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/field_clone_to_shell_layer.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/field_clone_to_shell_layer.md @@ -17,8 +17,8 @@ Generates a Field from the Field in input 0 that has the same FieldDefinition wi | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), enum dataProcessing::EShellLayers | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. | -| Pin 2| duplicate_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, a new scoping is computed for the output Field. If false, the input Field scoping is used. Default is false. | +| Pin 1
Required| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types), enum dataProcessing::EShellLayers | 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. | +| Pin 2| duplicate_scoping |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, a new scoping is computed for the output Field. If false, the input Field scoping is used. Default is false. | ## Outputs @@ -30,7 +30,7 @@ Generates a Field from the Field in input 0 that has the same FieldDefinition wi | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/field_get_attribute.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/field_get_attribute.md index 4093a7fbaf..a91505ecdf 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/field_get_attribute.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/field_get_attribute.md @@ -17,7 +17,7 @@ A Field in pin 0 and a property name (string) in pin 1 are expected in input. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Accepted inputs are: 'time_freq_support' and 'scoping'. | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Accepted inputs are: 'time_freq_support' and 'scoping'. | ## Outputs @@ -29,7 +29,7 @@ A Field in pin 0 and a property name (string) in pin 1 are expected in input. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/field_to_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/field_to_fc.md index 6dae016e26..b294d127dc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/field_to_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/field_to_fc.md @@ -29,7 +29,7 @@ Creates a fields container containing the field provided on pin 0. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/for_each.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/for_each.md index 21f2a6fea4..e034ab78de 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/for_each.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/for_each.md @@ -18,7 +18,7 @@ Allows to write a loop over a chunk of operators. |-------|-------|------------------|-------------| | Pin 0
Required| iterable | | Either the result of the make_iterable_info operator, or the operator that must be incremented. | | Pin 1| iterable_values | | | -| Pin 2| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 2| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 3
Required| forward | | | ## Outputs @@ -32,8 +32,8 @@ Allows to write a loop over a chunk of operators. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **evaluate_inputs_before_run** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, all input pins of the operator will be evaluated before entering the run method to maintain a correct Operator status. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **evaluate_inputs_before_run** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, all input pins of the operator will be evaluated before entering the run method to maintain a correct Operator status. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward.md index ac1085fc23..eb407a3127 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward.md @@ -28,8 +28,8 @@ Return all the inputs as outputs. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward_field.md index 12b6f198b5..07d600713b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward_field.md @@ -28,7 +28,7 @@ Returns the input field or fields container. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward_fields_container.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward_fields_container.md index 47cb9bf08a..132ccc4f7b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward_fields_container.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward_fields_container.md @@ -28,7 +28,7 @@ Returns the input field or fields container. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward_meshes_container.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward_meshes_container.md index fa2e6d5556..286bba0394 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward_meshes_container.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/forward_meshes_container.md @@ -17,7 +17,7 @@ Returns the input mesh or meshes container into a meshes container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| meshes |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | -| Pin 1| default_label |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | this default label is used if a new meshes container needs to be created (default is unknown) | +| Pin 1| default_label |[`string`](../../core-concepts/dpf-types.md#standard-types) | this default label is used if a new meshes container needs to be created (default is unknown) | ## Outputs @@ -29,7 +29,7 @@ Returns the input mesh or meshes container into a meshes container. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/hdf5dpf_workglow_provider.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/hdf5dpf_workglow_provider.md index f759a5b0c6..1348fd887a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/hdf5dpf_workglow_provider.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/hdf5dpf_workglow_provider.md @@ -33,7 +33,7 @@ Extract a custom result from an hdf5dpf file as an executable workflow. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/html_doc.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/html_doc.md index 586f761a7e..197b1bc9c1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/html_doc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/html_doc.md @@ -16,8 +16,8 @@ Create dpf's html documentation. Only on Windows. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| output_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | default is {working directory}/dataProcessingDoc.html | -| Pin 1| exposure_level |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Generate the documentation depending on exposure level : 0 (default) for public operators, 1 includes hidden operator, 2 includes private operator, 3 includes operator without specifications. | +| Pin 0| output_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | default is {working directory}/dataProcessingDoc.html | +| Pin 1| exposure_level |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Generate the documentation depending on exposure level : 0 (default) for public operators, 1 includes hidden operator, 2 includes private operator, 3 includes operator without specifications. | ## Outputs @@ -28,7 +28,7 @@ Create dpf's html documentation. Only on Windows. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_concatenate_as_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_concatenate_as_fc.md index 9de79935ca..0a65fcd0ef 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_concatenate_as_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_concatenate_as_fc.md @@ -29,7 +29,7 @@ Assemble fields in a fields container. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_field.md index 23d326a746..f7f5c8c6ca 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_field.md @@ -28,7 +28,7 @@ Incrementaly merge the input. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_fields_container.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_fields_container.md index 413b4e4c87..2c2e2d4b10 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_fields_container.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_fields_container.md @@ -28,7 +28,7 @@ Incrementaly merge the input. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_mesh.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_mesh.md index 1eccd5594f..176d463552 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_mesh.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_mesh.md @@ -28,7 +28,7 @@ Incrementaly merge the input. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_meshes_container.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_meshes_container.md index 4065a3f756..7cdfff6754 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_meshes_container.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_meshes_container.md @@ -28,7 +28,7 @@ Incrementaly merge the input. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_property_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_property_field.md index f462d6bf68..9c483cf3fe 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_property_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/incremental_merge_property_field.md @@ -28,7 +28,7 @@ Incrementaly merge the input. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/ints_to_scoping.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/ints_to_scoping.md index 7ab221257e..0d578bbc6a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/ints_to_scoping.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/ints_to_scoping.md @@ -16,8 +16,8 @@ take a int or a vector of int and transform it in a one entity field of location | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| int_or_vector_int |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | int or vector of int | -| Pin 1| location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0
Required| int_or_vector_int |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | int or vector of int | +| Pin 1| location |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -29,7 +29,7 @@ take a int or a vector of int and transform it in a one entity field of location | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_for_each_range.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_for_each_range.md index 26e9a1a726..d942c05e02 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_for_each_range.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_for_each_range.md @@ -16,10 +16,10 @@ Generate a range that can be consumed by the for_each operator | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1| try_generate_iterable |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, already iterable values connected in pin 3 like vectors, Scoping, TimefreqSupport, Containers and DataSources are split to iterate on it (default is true) | +| Pin -1| try_generate_iterable |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, already iterable values connected in pin 3 like vectors, Scoping, TimefreqSupport, Containers and DataSources are split to iterate on it (default is true) | | Pin 0| iterable | | Iterable object, generated by make_for_each_range oeprator, that can be combined with the one currently generated. | | Pin 1
Required| operator_to_iterate |[`operator`](../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | -| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 3
Required| valueA | | | | Pin 4
Required| valueB | | | | Pin 5
Required| valueC | | | @@ -34,7 +34,7 @@ Generate a range that can be consumed by the for_each operator | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_label_space.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_label_space.md index c9b9baec40..682dba058d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_label_space.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_label_space.md @@ -17,8 +17,8 @@ Assemble strings and integers to make a label space. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0| base_label |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | Used as a base label (extracted from Fields/Scoping Container, or directly from Label Space) that is concatenated with provided values. | -| Pin 1
Required| label_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 2
Required| label_value |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1
Required| label_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2
Required| label_value |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -30,7 +30,7 @@ Assemble strings and integers to make a label space. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_overall.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_overall.md index b69c7103a7..dd7088ef74 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_overall.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_overall.md @@ -17,7 +17,7 @@ Extracts a value from a field and makes a new field containing only this value, | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field) | | -| Pin 1
Required| id |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1
Required| id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -29,7 +29,7 @@ Extracts a value from a field and makes a new field containing only this value, | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_producer_consumer_for_each_iterator.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_producer_consumer_for_each_iterator.md index ed2af0654a..193693ad6d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_producer_consumer_for_each_iterator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/make_producer_consumer_for_each_iterator.md @@ -16,16 +16,16 @@ Generates an iterator that can be consumed by the for_each operator.The chain of | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1| try_generate_iterable |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | if true, already iterable values connected in pin 3 like vectors, Scoping, TimefreqSupport, Containers and DataSources are split to iterate on it (default is true) | +| Pin -1| try_generate_iterable |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true, already iterable values connected in pin 3 like vectors, Scoping, TimefreqSupport, Containers and DataSources are split to iterate on it (default is true) | | Pin 0| iterable | | Iterable object, generated by make_for_each_range oeprator, that can be combined with the one currently generated. | | Pin 1
Required| operator_to_iterate |[`operator`](../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | -| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 3
Required| valueA | | | | Pin 4
Required| valueB | | | | Pin 5
Required| valueC | | | | Pin 1000
Required| producer_op1 |[`operator`](../../core-concepts/dpf-types.md#operator) | | -| Pin 1001
Required| output_pin_of_producer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 1002
Required| input_pin_of_consumer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1001
Required| output_pin_of_producer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1002
Required| input_pin_of_consumer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 1003
Required| consumer_op1 |[`operator`](../../core-concepts/dpf-types.md#operator) | | ## Outputs @@ -38,7 +38,7 @@ Generates an iterator that can be consumed by the for_each operator.The chain of | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/mechanical_make_time_chunk_for_each.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/mechanical_make_time_chunk_for_each.md index e8b7d1a533..7b1092a308 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/mechanical_make_time_chunk_for_each.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/mechanical_make_time_chunk_for_each.md @@ -16,14 +16,14 @@ Splits a list of time/freq values into chunks depending on evaluated result prop | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| target_time_freq_values |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}) | List of time/freq values to potentially split in chunks. | +| Pin 0
Required| target_time_freq_values |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | List of time/freq values to potentially split in chunks. | | Pin 1
Required| operator_to_iterate |[`operator`](../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | -| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 7
Required| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | The number of nodes (for "Nodal" results) or number of elements (for "Elemental" results) is used to compute the chunk. | | Pin 200
Required| chunk_config |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | a data tree with an int attribute "max_num_bytes", an int attribute "dimensionality" (average result size by entity), a string attribute "location" ("Nodal" or"Elemental") is expected. | | Pin 1000
Required| producer_op1 |[`operator`](../../core-concepts/dpf-types.md#operator) | | -| Pin 1001
Required| output_pin_of_producer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 1002
Required| input_pin_of_consumer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1001
Required| output_pin_of_producer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1002
Required| input_pin_of_consumer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 1003
Required| consumer_op1 |[`operator`](../../core-concepts/dpf-types.md#operator) | | ## Outputs @@ -36,7 +36,7 @@ Splits a list of time/freq values into chunks depending on evaluated result prop | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/mechanical_make_time_freq_support_chunk_for_each.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/mechanical_make_time_freq_support_chunk_for_each.md index 55501ca5e5..6c68ab92ee 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/mechanical_make_time_freq_support_chunk_for_each.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/mechanical_make_time_freq_support_chunk_for_each.md @@ -18,12 +18,12 @@ Splits a time freq support into chunks depending on evaluated result properties, |-------|-------|------------------|-------------| | Pin 0
Required| target_time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | List of time freq support to potentially split in chunks. | | Pin 1
Required| operator_to_iterate |[`operator`](../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | -| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 7
Required| abstract_meshed_region |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | When a mesh is provided, the number of nodes (for "Nodal" results) or number of elements (for "Elemental" results) is used to compute the chunk. When a field is provided, its scoping size is used to compute the chunk. | | Pin 200
Required| chunk_config |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | a data tree with an int attribute "max_num_bytes", an int attribute "dimensionality" (average result size by entity), a string attribute "location" ("Nodal" or"Elemental") is expected. | | Pin 1000
Required| producer_op1 |[`operator`](../../core-concepts/dpf-types.md#operator) | | -| Pin 1001
Required| output_pin_of_producer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 1002
Required| input_pin_of_consumer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 1001
Required| output_pin_of_producer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1002
Required| input_pin_of_consumer_op1 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 1003
Required| consumer_op1 |[`operator`](../../core-concepts/dpf-types.md#operator) | | ## Outputs @@ -36,7 +36,7 @@ Splits a time freq support into chunks depending on evaluated result properties, | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_any.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_any.md index 53770e7427..636b7bfe79 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_any.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_any.md @@ -28,8 +28,8 @@ Merges a list of objects having the same data types. Once the data type is found | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_collections.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_collections.md index c662e71a39..764bf1ac99 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_collections.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_collections.md @@ -28,8 +28,8 @@ Merges a set of collections into a unique one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_data_tree.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_data_tree.md index eb4d0e919f..dc32c83416 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_data_tree.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_data_tree.md @@ -28,8 +28,8 @@ Merges a list of data trees. Attributes names shouldn't be shared accross data t | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **permissive** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields.md index 386dac1b74..a04560c1bd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields.md @@ -16,7 +16,7 @@ Assembles a set of fields into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -2| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Default is false. If true, redundant quantities are summed instead of being ignored. | +| Pin -2| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | | Pin -1| merged_support |[`abstract_field_support`](../../core-concepts/dpf-types.md#field-support) | Already merged field support. | | Pin 0
Required| fields |[`vector>`](../../core-concepts/dpf-types.md#vector>), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | @@ -30,8 +30,8 @@ Assembles a set of fields into a unique one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields_by_label.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields_by_label.md index 53fc1cd3b4..e8f6d6133b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields_by_label.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields_by_label.md @@ -17,9 +17,9 @@ Merges the fields of a fields container that share the same label value. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Label identifier that should be merged. | +| Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label identifier that should be merged. | | Pin 2| merged_field_support |[`abstract_field_support`](../../core-concepts/dpf-types.md#field-support) | The FieldsContainer's support that has already been merged. | -| Pin 3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Default is false. If true, redundant quantities are summed instead of being ignored. | +| Pin 3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | ## Outputs @@ -32,7 +32,7 @@ Merges the fields of a fields container that share the same label value. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields_container_matrices_label.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields_container_matrices_label.md index 4a2d60c367..f928023f5c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields_container_matrices_label.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields_container_matrices_label.md @@ -17,8 +17,8 @@ Merge fields of fields container into field matrices. The output is a fields con | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | fields container to be merged | -| Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Label where the merge is required | -| Pin 2| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`scoping`](../../core-concepts/dpf-types.md#scoping) | if it's specified, fields container of field matrices is constructed only on the specified time scoping | +| Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label where the merge is required | +| Pin 2| time_scoping |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | if it's specified, fields container of field matrices is constructed only on the specified time scoping | ## Outputs @@ -30,7 +30,7 @@ Merge fields of fields container into field matrices. The output is a fields con | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields_containers.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields_containers.md index d167f20230..d061ae54d1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields_containers.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_fields_containers.md @@ -16,8 +16,8 @@ Assembles a set of fields containers into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -200| should_merge_named_selections |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. | -| Pin -3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Default is false. If true, redundant quantities are summed instead of being ignored. | +| Pin -200| should_merge_named_selections |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. | +| Pin -3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | | Pin -2| merged_fields_support |[`abstract_field_support`](../../core-concepts/dpf-types.md#field-support) | Already merged field support. | | Pin -1| merged_fields_containers_support |[`abstract_field_support`](../../core-concepts/dpf-types.md#field-support), [`umap>`](../../core-concepts/dpf-types.md#umap>) | Already merged fields containers support. | | Pin 0
Required| fields_containers |[`vector>`](../../core-concepts/dpf-types.md#vector>), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A vector of fields containers to merge or fields containers from pin 0 to ... | @@ -32,8 +32,8 @@ Assembles a set of fields containers into a unique one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_generic_data_container.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_generic_data_container.md index 76909211f9..0b15aa23a8 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_generic_data_container.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_generic_data_container.md @@ -28,7 +28,7 @@ Merges a list of generic data container. For each data entry, the merge operatio | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_materials.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_materials.md index 64d0322398..dff5b61399 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_materials.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_materials.md @@ -28,7 +28,7 @@ Assembles a set of materials into a unique one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_meshes.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_meshes.md index c39260a27b..28b69a2d83 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_meshes.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_meshes.md @@ -16,12 +16,12 @@ Take a set of meshes and assemble them in a unique one | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -201| naive_merge_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, merge the elemental Property Fields of the input meshes assuming that there is no repetition in their scoping ids. Default is false. | -| Pin -200| should_merge_named_selections |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | For certain types of files (such as RST), scoping from names selection does not need to be merged.If this pin is true, the merge occurs. If this pin is false, the merge does not occur. Default is true. | +| Pin -201| naive_merge_elements |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, merge the elemental Property Fields of the input meshes assuming that there is no repetition in their scoping ids. Default is false. | +| Pin -200| should_merge_named_selections |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For certain types of files (such as RST), scoping from names selection does not need to be merged.If this pin is true, the merge occurs. If this pin is false, the merge does not occur. Default is true. | | Pin 0
Required| meshes |[`vector>`](../../core-concepts/dpf-types.md#vector>), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | A vector of meshed region to merge or meshed region from pin 0 to ... | -| Pin 101| merge_method |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0: merge by distance, 1: merge by node id (default) | -| Pin 102| box_size |[`double`](../../core-concepts/dpf-types.md#standard-types}}) | Box size used when merging by distance. Default value is 1e-12. | -| Pin 103| remove_duplicate_elements |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0: keep duplicate elements (default), 1: remove duplicate elements | +| Pin 101| merge_method |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: merge by distance, 1: merge by node id (default) | +| Pin 102| box_size |[`double`](../../core-concepts/dpf-types.md#standard-types) | Box size used when merging by distance. Default value is 1e-12. | +| Pin 103| remove_duplicate_elements |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0: keep duplicate elements (default), 1: remove duplicate elements | ## Outputs @@ -33,8 +33,8 @@ Take a set of meshes and assemble them in a unique one | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_meshes_containers.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_meshes_containers.md index 493072a8e3..d40cc4e59a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_meshes_containers.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_meshes_containers.md @@ -28,8 +28,8 @@ Assembles a set of meshes containers into a unique one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_property_fields.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_property_fields.md index ce3588ec67..3fd678f068 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_property_fields.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_property_fields.md @@ -16,7 +16,7 @@ Assembles a set of property fields into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -201
Required| naive_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, merge the input property fields assuming that there is no repetition in their scoping ids. Default is false. | +| Pin -201
Required| naive_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, merge the input property fields assuming that there is no repetition in their scoping ids. Default is false. | | Pin 0
Required| property_fields |[`vector>`](../../core-concepts/dpf-types.md#vector>), [`property_field`](../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | Either a property fields container, a vector of property fields to merge or property fields from pin 0 to ... | ## Outputs @@ -29,7 +29,7 @@ Assembles a set of property fields into a unique one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_result_infos.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_result_infos.md index a6a6073ea0..f6a444cb3e 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_result_infos.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_result_infos.md @@ -28,8 +28,8 @@ Assembles a set of result information into a unique one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_scopings.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_scopings.md index c8b8b8cf06..20c33b93bd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_scopings.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_scopings.md @@ -28,7 +28,7 @@ Assembles a set of scopings into a unique one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_scopings_containers.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_scopings_containers.md index 9ef5b4ff9c..691adeaa78 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_scopings_containers.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_scopings_containers.md @@ -28,7 +28,7 @@ Assembles a set of scopings containers into a unique one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_string_fields.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_string_fields.md index 7c88d40d76..775c2957b5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_string_fields.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_string_fields.md @@ -28,7 +28,7 @@ Assembles a set of string fields into a unique one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_supports.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_supports.md index e5f4ac3135..d9592333e4 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_supports.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_supports.md @@ -16,7 +16,7 @@ Assembles a set of supports into a unique one. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -200| should_merge_named_selections |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. | +| Pin -200| should_merge_named_selections |[`bool`](../../core-concepts/dpf-types.md#standard-types) | For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. | | Pin 0
Required| supports |[`vector>`](../../core-concepts/dpf-types.md#vector>), [`abstract_field_support`](../../core-concepts/dpf-types.md#field-support) | A vector of supports to merge or supports from pin 0 to ... | ## Outputs @@ -29,7 +29,7 @@ Assembles a set of supports into a unique one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_time_freq_supports.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_time_freq_supports.md index 7e51502df2..03aea2af7c 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_time_freq_supports.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_time_freq_supports.md @@ -28,7 +28,7 @@ Assembles a set of time/frequency supports into a unique one. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_to_field_matrix.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_to_field_matrix.md index 06a9295a9a..89734fcb9d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_to_field_matrix.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_to_field_matrix.md @@ -28,7 +28,7 @@ Assembles a set of fields into a field matrix. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_weighted_fields.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_weighted_fields.md index f310a9c45e..246a83987f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_weighted_fields.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_weighted_fields.md @@ -16,7 +16,7 @@ Assembles a set of fields into a unique one, applying a weight on the sum of the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -2| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Default is false. If true, redundant quantities are summed instead of being ignored. | +| Pin -2| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | | Pin -1| merged_support |[`abstract_field_support`](../../core-concepts/dpf-types.md#field-support) | Already merged field support. | | Pin 0
Required| fields |[`vector>`](../../core-concepts/dpf-types.md#vector>), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Either a fields container, a vector of fields to merge, or fields from pin 0 to ... | | Pin 1000
Required| weights |[`vector>`](../../core-concepts/dpf-types.md#vector>), [`property_field`](../../core-concepts/dpf-types.md#property-field) | Weights to apply to each field from pin 1000 to ... | @@ -31,7 +31,7 @@ Assembles a set of fields into a unique one, applying a weight on the sum of the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_weighted_fields_containers.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_weighted_fields_containers.md index 7dcd5cfd3d..597e2b77ba 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_weighted_fields_containers.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/merge_weighted_fields_containers.md @@ -16,7 +16,7 @@ Assembles a set of fields containers into a unique one, applying a weight on the | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Default is false. If true, redundant quantities are summed instead of being ignored. | +| Pin -3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | | Pin -2| merged_fields_support |[`abstract_field_support`](../../core-concepts/dpf-types.md#field-support) | Already merged field support. | | Pin -1| merged_fields_containers_support |[`abstract_field_support`](../../core-concepts/dpf-types.md#field-support), [`umap>`](../../core-concepts/dpf-types.md#umap>) | Already merged fields containers support. | | Pin 0
Required| fields_containers |[`vector>`](../../core-concepts/dpf-types.md#vector>), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | A vector of fields containers to merge or fields containers from pin 0 to ... | @@ -32,8 +32,8 @@ Assembles a set of fields containers into a unique one, applying a weight on the | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/mesh_to_mc.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/mesh_to_mc.md index be10d711de..ce3f12f693 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/mesh_to_mc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/mesh_to_mc.md @@ -29,7 +29,7 @@ Creates a meshes container containing the mesh provided on pin 0. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/operator_id.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/operator_id.md index 468a25771e..47afe57b98 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/operator_id.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/operator_id.md @@ -22,13 +22,13 @@ Return the id of an Operator. | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| id |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| **Pin 0**| id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/overlap_fields.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/overlap_fields.md index b51ae4dddf..1818238e49 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/overlap_fields.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/overlap_fields.md @@ -29,7 +29,7 @@ Take two fields and superpose them, the overlapping field will override values o | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/producer_consumer_for_each.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/producer_consumer_for_each.md index 2af6f81ae6..bd719d4dc7 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/producer_consumer_for_each.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/producer_consumer_for_each.md @@ -30,8 +30,8 @@ Allows to write a loop over operators by connecting data to iterate and by reque | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **evaluate_inputs_before_run** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, all input pins of the operator will be evaluated before entering the run method to maintain a correct Operator status. | -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **evaluate_inputs_before_run** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, all input pins of the operator will be evaluated before entering the run method to maintain a correct Operator status. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/python_generator.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/python_generator.md index 9910e4214c..219915705d 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/python_generator.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/python_generator.md @@ -16,10 +16,10 @@ Generates .py file with specifications for loaded plugin(s). | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| dll_source_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 1
Required| output_path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 2| load_symbol |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | -| Pin 3| library_key |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 0
Required| dll_source_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 1
Required| output_path |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 2| load_symbol |[`string`](../../core-concepts/dpf-types.md#standard-types) | | +| Pin 3| library_key |[`string`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -30,7 +30,7 @@ Generates .py file with specifications for loaded plugin(s). | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/remote_operator_instantiate.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/remote_operator_instantiate.md index fa69cfb172..d83705c895 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/remote_operator_instantiate.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/remote_operator_instantiate.md @@ -16,11 +16,11 @@ Create a local image of an existing remote operator (identified by an id and an | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| operator_to_send |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | local workflow to push to a remote or id of a remote workflow | -| Pin 1
Required| output_pin |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | pin number of the output to name | +| Pin 0
Required| operator_to_send |[`int32`](../../core-concepts/dpf-types.md#standard-types) | local workflow to push to a remote or id of a remote workflow | +| Pin 1
Required| output_pin |[`int32`](../../core-concepts/dpf-types.md#standard-types) | pin number of the output to name | | Pin 3
Required| streams_to_remote |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | | Pin 4| data_sources_to_remote |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | -| Pin 5
Required| output_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | output's name of the workflow to return | +| Pin 5
Required| output_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | output's name of the workflow to return | ## Outputs @@ -32,9 +32,9 @@ Create a local image of an existing remote operator (identified by an id and an | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/remote_workflow_instantiate.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/remote_workflow_instantiate.md index 8736543aec..9ab47b7e95 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/remote_workflow_instantiate.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/remote_workflow_instantiate.md @@ -16,7 +16,7 @@ Sends a local workflow to a remote process (and keep a local image of it) or cre | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| workflow_to_send |[`workflow`](../../core-concepts/dpf-types.md#workflow), [`int32`](../../core-concepts/dpf-types.md#standard-types}}) | local workflow to push to a remote or id of a remote workflow | +| Pin 0
Required| workflow_to_send |[`workflow`](../../core-concepts/dpf-types.md#workflow), [`int32`](../../core-concepts/dpf-types.md#standard-types) | local workflow to push to a remote or id of a remote workflow | | Pin 3
Required| streams_to_remote |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | | | Pin 4| data_sources_to_remote |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | @@ -30,9 +30,9 @@ Sends a local workflow to a remote process (and keep a local image of it) or cre | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | 0 | Number of threads to use to run in parallel | -| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | true | Loops are allowed to run in parallel if the value of this config is set to true. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel | +| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/remove_unnecessary_labels.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/remove_unnecessary_labels.md index 654c3aba88..ee74964f29 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/remove_unnecessary_labels.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/remove_unnecessary_labels.md @@ -16,9 +16,9 @@ Removes the selected label from a fields container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin -1| permissive |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | If true, the operator does not throw an error if the label to be removed has more than one entry. | +| Pin -1| permissive |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, the operator does not throw an error if the label to be removed has more than one entry. | | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields Container with the label to be removed. | -| Pin 1
Required| label_to_remove |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Label to be removed from the fields container. | +| Pin 1
Required| label_to_remove |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label to be removed from the fields container. | ## Outputs @@ -30,8 +30,8 @@ Removes the selected label from a fields container. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | -| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **read_inputs_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the operator's inputs will be evaluated in parallel. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/scalars_to_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/scalars_to_field.md index c326827b85..d8aa9fd7dc 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/scalars_to_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/scalars_to_field.md @@ -16,11 +16,11 @@ Create scalar or vector Field. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| double_or_vector_double |[`double`](../../core-concepts/dpf-types.md#standard-types}}), [`vector`](../../core-concepts/dpf-types.md#standard-types}}) | Data of the field, default is 0-field. Specify a double to have a field of same value or specify directly the data vector. | -| Pin 1| unit |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Unit symbol (m, Hz, kg, ...) | -| Pin 2| location |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Location of the field ex 'Nodal', 'ElementalNodal', 'Elemental'... Default is 'numeric'. | -| Pin 3| num_entity |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Number of field entities. Default is 1 or the size of the scoping in input if specified. | -| Pin 4| num_comp |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Number of field components. Default is 1. | +| Pin 0| double_or_vector_double |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | Data of the field, default is 0-field. Specify a double to have a field of same value or specify directly the data vector. | +| Pin 1| unit |[`string`](../../core-concepts/dpf-types.md#standard-types) | Unit symbol (m, Hz, kg, ...) | +| Pin 2| location |[`string`](../../core-concepts/dpf-types.md#standard-types) | Location of the field ex 'Nodal', 'ElementalNodal', 'Elemental'... Default is 'numeric'. | +| Pin 3| num_entity |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of field entities. Default is 1 or the size of the scoping in input if specified. | +| Pin 4| num_comp |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Number of field components. Default is 1. | | Pin 5| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Scoping. | ## Outputs @@ -33,7 +33,7 @@ Create scalar or vector Field. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/server_path.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/server_path.md index a52f3a484f..2b956ddfca 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/server_path.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/server_path.md @@ -16,19 +16,19 @@ Returns the platform-specific path to a folder in the Dpf server | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0| subpath |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | Subpath of the Dpf server. Supported values: 0 (default): root of the server, 1: "dpf/bin/platform", 2: "aisol/bin(dll)/platform", 3: "dpf/plugins", 4: "dpf/workflows". | +| Pin 0| subpath |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Subpath of the Dpf server. Supported values: 0 (default): root of the server, 1: "dpf/bin/platform", 2: "aisol/bin(dll)/platform", 3: "dpf/plugins", 4: "dpf/workflows". | ## Outputs | Output | Name | Expected type(s) | Description | |-------|------|------------------|-------------| -| **Pin 0**| path |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Path to the requested folder in the Dpf server | +| **Pin 0**| path |[`string`](../../core-concepts/dpf-types.md#standard-types) | Path to the requested folder in the Dpf server | ## Configurations | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/set_attribute.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/set_attribute.md index 9d6606f8b1..0cf8a2f98b 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/set_attribute.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/set_attribute.md @@ -17,8 +17,8 @@ Uses the FieldsContainer APIs to modify it. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Supported property names are: "labels". | -| Pin 2| property_identifier |[`vector`](../../core-concepts/dpf-types.md#standard-types}}), [`label_space`](../../core-concepts/dpf-types.md#label-space) | Value of the property to be set : vector of string or LabelSpace for "labels". | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "labels". | +| Pin 2| property_identifier |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`label_space`](../../core-concepts/dpf-types.md#label-space) | Value of the property to be set : vector of string or LabelSpace for "labels". | ## Outputs @@ -30,7 +30,7 @@ Uses the FieldsContainer APIs to modify it. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/set_property.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/set_property.md index 9b139ff20e..89acbab8a5 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/set_property.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/set_property.md @@ -17,8 +17,8 @@ Sets a property to an input field/field container. | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| field |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Property to set | -| Pin 2
Required| property_value |[`string`](../../core-concepts/dpf-types.md#standard-types}}), [`int32`](../../core-concepts/dpf-types.md#standard-types}}), [`double`](../../core-concepts/dpf-types.md#standard-types}}) | Property to set | +| Pin 1
Required| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Property to set | +| Pin 2
Required| property_value |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | Property to set | ## Outputs @@ -30,7 +30,7 @@ Sets a property to an input field/field container. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/split_in_for_each_range.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/split_in_for_each_range.md index 8158ced323..a1afee589f 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/split_in_for_each_range.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/split_in_for_each_range.md @@ -18,9 +18,9 @@ Split a scoping into several pieces so you can iterate it with a for_each loop. |-------|-------|------------------|-------------| | Pin 0| iterable | | Iterable that can be combined with the one currently generated. | | Pin 1
Required| operator_to_iterate |[`operator`](../../core-concepts/dpf-types.md#operator) | Operator that must be reconnected with the range values. | -| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 2
Required| pin_index |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | | Pin 3
Required| scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | -| Pin 4
Required| chunk_size |[`int32`](../../core-concepts/dpf-types.md#standard-types}}) | | +| Pin 4
Required| chunk_size |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | ## Outputs @@ -32,7 +32,7 @@ Split a scoping into several pieces so you can iterate it with a for_each loop. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/strain_from_voigt.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/strain_from_voigt.md index 0e604aaa65..ea9627b057 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/strain_from_voigt.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/strain_from_voigt.md @@ -28,7 +28,7 @@ Converts the strain field from Voigt notation into standard format. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/strain_from_voigt_fc.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/strain_from_voigt_fc.md index bc51d0eff5..794d7931bd 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/strain_from_voigt_fc.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/strain_from_voigt_fc.md @@ -28,7 +28,7 @@ Converts the strain field from Voigt notation into standard format. | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/txt_file_to_dpf.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/txt_file_to_dpf.md index 397d5d8dcf..c86b32f3c1 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/txt_file_to_dpf.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/txt_file_to_dpf.md @@ -16,7 +16,7 @@ Take an input string and parse it into dataProcessing type | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| -| Pin 0
Required| input_string |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | ex: 'double:1.0', 'int:1', 'vector:1.0;1.0' | +| Pin 0
Required| input_string |[`string`](../../core-concepts/dpf-types.md#standard-types) | ex: 'double:1.0', 'int:1', 'vector:1.0;1.0' | ## Outputs @@ -28,7 +28,7 @@ Take an input string and parse it into dataProcessing type | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/unitary_field.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/unitary_field.md index ce19e05059..9a5c03004a 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/unitary_field.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/unitary_field.md @@ -28,7 +28,7 @@ Takes a field and returns another field of scalars in the same location and scop | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/dpf-framework-25-r2/operator-specifications/utility/weighted_merge_fields_by_label.md b/2025R2/dpf-framework-25-r2/operator-specifications/utility/weighted_merge_fields_by_label.md index 91c27f1fda..6029a448fa 100644 --- a/2025R2/dpf-framework-25-r2/operator-specifications/utility/weighted_merge_fields_by_label.md +++ b/2025R2/dpf-framework-25-r2/operator-specifications/utility/weighted_merge_fields_by_label.md @@ -17,9 +17,9 @@ Performs a weighted merge on fields of a fields container that share the same la | Input | Name | Expected type(s) | Description | |-------|-------|------------------|-------------| | Pin 0
Required| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | -| Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types}}) | Label identifier that should be merged. | +| Pin 1
Required| label |[`string`](../../core-concepts/dpf-types.md#standard-types) | Label identifier that should be merged. | | Pin 2| merged_field_support |[`abstract_field_support`](../../core-concepts/dpf-types.md#field-support) | The FieldsContainer's support that has already been merged. | -| Pin 3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | Default is false. If true, redundant quantities are summed instead of being ignored. | +| Pin 3| sum_merge |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Default is false. If true, redundant quantities are summed instead of being ignored. | | Pin 1000
Required| weights |vector>>, [`property_field`](../../core-concepts/dpf-types.md#property-field) | Weights to apply to each field from pin 1000 to ... | ## Outputs @@ -32,7 +32,7 @@ Performs a weighted merge on fields of a fields container that share the same la | Name| Expected type(s) | Default value | Description | |-----|------|----------|-------------| -| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types}}) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | +| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. | ## Scripting diff --git a/2025R2/modelCenter_java_api/toc.yml b/2025R2/modelCenter_java_api/toc.yml index 0675543096..8cee818524 100644 --- a/2025R2/modelCenter_java_api/toc.yml +++ b/2025R2/modelCenter_java_api/toc.yml @@ -122,226 +122,227 @@ href: com/phoenix_int/aserver/client/v2/AnalysisVariableValue.md - name: IAnalysisServerCallback href: com/phoenix_int/aserver/client/v2/IAnalysisServerCallback.md - - name: library - items: - - name: Package Summary - href: com/phoenix_int/aserver/library/package-summary.md - - name: Package Tree - href: com/phoenix_int/aserver/library/package-tree.md - - name: IPHXFactory - href: com/phoenix_int/aserver/library/IPHXFactory.md - - name: IPHXLibrarian - href: com/phoenix_int/aserver/library/IPHXLibrarian.md - - name: IPHXVersionedLibrarian - href: com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md - - name: IPHXVersionedLibrarian2 - href: com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md - - name: PHXCVSLibrarian - href: com/phoenix_int/aserver/library/PHXCVSLibrarian.md - - name: PHXDirectoryLibrarian - href: com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md - - name: PHXLibrarianCombiner - href: com/phoenix_int/aserver/library/PHXLibrarianCombiner.md - - name: PHXLibrarianMounter - href: com/phoenix_int/aserver/library/PHXLibrarianMounter.md - - name: PHXNoSuchAssociationException - href: com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md - - name: PHXNoSuchCategoryException - href: com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md - - name: PHXNoSuchIconException - href: com/phoenix_int/aserver/library/PHXNoSuchIconException.md - - name: PHXUserDirLibrarian - href: com/phoenix_int/aserver/library/PHXUserDirLibrarian.md - - name: monitors - items: - - name: Package Summary - href: com/phoenix_int/aserver/monitors/package-summary.md - - name: Package Tree - href: com/phoenix_int/aserver/monitors/package-tree.md - - name: IPHXFileCallback - href: com/phoenix_int/aserver/monitors/IPHXFileCallback.md - - name: PHXFileMonitor.FileMonitorChangeException - href: com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md - - name: PHXFileMonitor - href: com/phoenix_int/aserver/monitors/PHXFileMonitor.md - - name: PHXMonitorableStream - href: com/phoenix_int/aserver/monitors/PHXMonitorableStream.md - - name: PHXMonitorableStream.MonitorWriter - href: com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md - - name: types - items: - - name: Package Summary - href: com/phoenix_int/aserver/types/package-summary.md - - name: Package Tree - href: com/phoenix_int/aserver/types/package-tree.md - - name: IPHXDescription - href: com/phoenix_int/aserver/types/IPHXDescription.md - - name: IPHXFormat - href: com/phoenix_int/aserver/types/IPHXFormat.md - - name: IPHXRefPropInfo - href: com/phoenix_int/aserver/types/IPHXRefPropInfo.md - - name: IPHXType - href: com/phoenix_int/aserver/types/IPHXType.md - - name: IPHXType2 - href: com/phoenix_int/aserver/types/IPHXType2.md - - name: IPHXType2.IVisitor - href: com/phoenix_int/aserver/types/IPHXType2.IVisitor.md - - name: IPHXUnits - href: com/phoenix_int/aserver/types/IPHXUnits.md - - name: PHXAppearance - href: com/phoenix_int/aserver/types/PHXAppearance.md - - name: PHXBoolean - href: com/phoenix_int/aserver/types/PHXBoolean.md - - name: PHXBooleanArray - href: com/phoenix_int/aserver/types/PHXBooleanArray.md - - name: PHXDataCollector - href: com/phoenix_int/aserver/types/PHXDataCollector.md - - name: PHXDouble - href: com/phoenix_int/aserver/types/PHXDouble.md - - name: PHXDoubleArray - href: com/phoenix_int/aserver/types/PHXDoubleArray.md - - name: PHXFile - href: com/phoenix_int/aserver/types/PHXFile.md - - name: PHXGeometry - href: com/phoenix_int/aserver/types/PHXGeometry.md - - name: PHXGeomInfo - href: com/phoenix_int/aserver/types/PHXGeomInfo.md - - name: PHXInteger - href: com/phoenix_int/aserver/types/PHXInteger.md - - name: PHXInvalidTypeException - href: com/phoenix_int/aserver/types/PHXInvalidTypeException.md - - name: PHXLong - href: com/phoenix_int/aserver/types/PHXLong.md - - name: PHXLongArray - href: com/phoenix_int/aserver/types/PHXLongArray.md - - name: PHXMassProperties - href: com/phoenix_int/aserver/types/PHXMassProperties.md - - name: PHXNumberFormatException - href: com/phoenix_int/aserver/types/PHXNumberFormatException.md - - name: PHXObjectArray - href: com/phoenix_int/aserver/types/PHXObjectArray.md - - name: PHXOrientation - href: com/phoenix_int/aserver/types/PHXOrientation.md - - name: PHXRawFile - href: com/phoenix_int/aserver/types/PHXRawFile.md - - name: PHXRawFileArray - href: com/phoenix_int/aserver/types/PHXRawFileArray.md - - name: PHXRefArrayProperty - href: com/phoenix_int/aserver/types/PHXRefArrayProperty.md - - name: PHXReference - href: com/phoenix_int/aserver/types/PHXReference.md - - name: PHXReferenceArray - href: com/phoenix_int/aserver/types/PHXReferenceArray.md - - name: PHXRefProperty - href: com/phoenix_int/aserver/types/PHXRefProperty.md - - name: PHXScriptObject - href: com/phoenix_int/aserver/types/PHXScriptObject.md - - name: PHXSimpleArray - href: com/phoenix_int/aserver/types/PHXSimpleArray.md - - name: PHXSimpleType - href: com/phoenix_int/aserver/types/PHXSimpleType.md - - name: PHXString - href: com/phoenix_int/aserver/types/PHXString.md - - name: PHXStringArray - href: com/phoenix_int/aserver/types/PHXStringArray.md - - name: PHXTypeFactory - href: com/phoenix_int/aserver/types/PHXTypeFactory.md - - name: PHXTypeMismatchException - href: com/phoenix_int/aserver/types/PHXTypeMismatchException.md - - name: util + - name: library + items: + - name: Package Summary + href: com/phoenix_int/aserver/library/package-summary.md + - name: Package Tree + href: com/phoenix_int/aserver/library/package-tree.md + - name: IPHXFactory + href: com/phoenix_int/aserver/library/IPHXFactory.md + - name: IPHXLibrarian + href: com/phoenix_int/aserver/library/IPHXLibrarian.md + - name: IPHXVersionedLibrarian + href: com/phoenix_int/aserver/library/IPHXVersionedLibrarian.md + - name: IPHXVersionedLibrarian2 + href: com/phoenix_int/aserver/library/IPHXVersionedLibrarian2.md + - name: PHXCVSLibrarian + href: com/phoenix_int/aserver/library/PHXCVSLibrarian.md + - name: PHXDirectoryLibrarian + href: com/phoenix_int/aserver/library/PHXDirectoryLibrarian.md + - name: PHXLibrarianCombiner + href: com/phoenix_int/aserver/library/PHXLibrarianCombiner.md + - name: PHXLibrarianMounter + href: com/phoenix_int/aserver/library/PHXLibrarianMounter.md + - name: PHXNoSuchAssociationException + href: com/phoenix_int/aserver/library/PHXNoSuchAssociationException.md + - name: PHXNoSuchCategoryException + href: com/phoenix_int/aserver/library/PHXNoSuchCategoryException.md + - name: PHXNoSuchIconException + href: com/phoenix_int/aserver/library/PHXNoSuchIconException.md + - name: PHXUserDirLibrarian + href: com/phoenix_int/aserver/library/PHXUserDirLibrarian.md + - name: monitors + items: + - name: Package Summary + href: com/phoenix_int/aserver/monitors/package-summary.md + - name: Package Tree + href: com/phoenix_int/aserver/monitors/package-tree.md + - name: IPHXFileCallback + href: com/phoenix_int/aserver/monitors/IPHXFileCallback.md + - name: PHXFileMonitor.FileMonitorChangeException + href: com/phoenix_int/aserver/monitors/PHXFileMonitor.FileMonitorChangeException.md + - name: PHXFileMonitor + href: com/phoenix_int/aserver/monitors/PHXFileMonitor.md + - name: PHXMonitorableStream + href: com/phoenix_int/aserver/monitors/PHXMonitorableStream.md + - name: PHXMonitorableStream.MonitorWriter + href: com/phoenix_int/aserver/monitors/PHXMonitorableStream.MonitorWriter.md + - name: types + items: + - name: Package Summary + href: com/phoenix_int/aserver/types/package-summary.md + - name: Package Tree + href: com/phoenix_int/aserver/types/package-tree.md + - name: IPHXDescription + href: com/phoenix_int/aserver/types/IPHXDescription.md + - name: IPHXFormat + href: com/phoenix_int/aserver/types/IPHXFormat.md + - name: IPHXRefPropInfo + href: com/phoenix_int/aserver/types/IPHXRefPropInfo.md + - name: IPHXType + href: com/phoenix_int/aserver/types/IPHXType.md + - name: IPHXType2 + href: com/phoenix_int/aserver/types/IPHXType2.md + - name: IPHXType2.IVisitor + href: com/phoenix_int/aserver/types/IPHXType2.IVisitor.md + - name: IPHXUnits + href: com/phoenix_int/aserver/types/IPHXUnits.md + - name: PHXAppearance + href: com/phoenix_int/aserver/types/PHXAppearance.md + - name: PHXBoolean + href: com/phoenix_int/aserver/types/PHXBoolean.md + - name: PHXBooleanArray + href: com/phoenix_int/aserver/types/PHXBooleanArray.md + - name: PHXDataCollector + href: com/phoenix_int/aserver/types/PHXDataCollector.md + - name: PHXDouble + href: com/phoenix_int/aserver/types/PHXDouble.md + - name: PHXDoubleArray + href: com/phoenix_int/aserver/types/PHXDoubleArray.md + - name: PHXFile + href: com/phoenix_int/aserver/types/PHXFile.md + - name: PHXGeometry + href: com/phoenix_int/aserver/types/PHXGeometry.md + - name: PHXGeomInfo + href: com/phoenix_int/aserver/types/PHXGeomInfo.md + - name: PHXInteger + href: com/phoenix_int/aserver/types/PHXInteger.md + - name: PHXInvalidTypeException + href: com/phoenix_int/aserver/types/PHXInvalidTypeException.md + - name: PHXLong + href: com/phoenix_int/aserver/types/PHXLong.md + - name: PHXLongArray + href: com/phoenix_int/aserver/types/PHXLongArray.md + - name: PHXMassProperties + href: com/phoenix_int/aserver/types/PHXMassProperties.md + - name: PHXNumberFormatException + href: com/phoenix_int/aserver/types/PHXNumberFormatException.md + - name: PHXObjectArray + href: com/phoenix_int/aserver/types/PHXObjectArray.md + - name: PHXOrientation + href: com/phoenix_int/aserver/types/PHXOrientation.md + - name: PHXRawFile + href: com/phoenix_int/aserver/types/PHXRawFile.md + - name: PHXRawFileArray + href: com/phoenix_int/aserver/types/PHXRawFileArray.md + - name: PHXRefArrayProperty + href: com/phoenix_int/aserver/types/PHXRefArrayProperty.md + - name: PHXReference + href: com/phoenix_int/aserver/types/PHXReference.md + - name: PHXReferenceArray + href: com/phoenix_int/aserver/types/PHXReferenceArray.md + - name: PHXRefProperty + href: com/phoenix_int/aserver/types/PHXRefProperty.md + - name: PHXScriptObject + href: com/phoenix_int/aserver/types/PHXScriptObject.md + - name: PHXSimpleArray + href: com/phoenix_int/aserver/types/PHXSimpleArray.md + - name: PHXSimpleType + href: com/phoenix_int/aserver/types/PHXSimpleType.md + - name: PHXString + href: com/phoenix_int/aserver/types/PHXString.md + - name: PHXStringArray + href: com/phoenix_int/aserver/types/PHXStringArray.md + - name: PHXTypeFactory + href: com/phoenix_int/aserver/types/PHXTypeFactory.md + - name: PHXTypeMismatchException + href: com/phoenix_int/aserver/types/PHXTypeMismatchException.md + - name: util + items: + - name: Package Summary + href: com/phoenix_int/aserver/util/package-summary.md + - name: Package Tree + href: com/phoenix_int/aserver/util/package-tree.md + - name: IPHXLineStore + href: com/phoenix_int/aserver/util/IPHXLineStore.md + - name: IPHXStringReplacer + href: com/phoenix_int/aserver/util/IPHXStringReplacer.md + - name: Parser + href: com/phoenix_int/aserver/util/Parser.md + - name: Parser.Mode + href: com/phoenix_int/aserver/util/Parser.Mode.md + - name: PHXClassNotFoundException + href: com/phoenix_int/aserver/util/PHXClassNotFoundException.md + - name: PHXFileLoader + href: com/phoenix_int/aserver/util/PHXFileLoader.md + - name: PHXFileName + href: com/phoenix_int/aserver/util/PHXFileName.md + - name: PHXFileParser + href: com/phoenix_int/aserver/util/PHXFileParser.md + - name: PHXGetByUrlException + href: com/phoenix_int/aserver/util/PHXGetByUrlException.md + - name: PHXIcon + href: com/phoenix_int/aserver/util/PHXIcon.md + - name: PHXNameDivider + href: com/phoenix_int/aserver/util/PHXNameDivider.md + - name: PHXNoSuchReplacementException + href: com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md + - name: PHXNoSuchTokenException + href: com/phoenix_int/aserver/util/PHXNoSuchTokenException.md + - name: PHXProcess + href: com/phoenix_int/aserver/util/PHXProcess.md + - name: PHXProcessInfo + href: com/phoenix_int/aserver/util/PHXProcessInfo.md + - name: PHXRuntime + href: com/phoenix_int/aserver/util/PHXRuntime.md + - name: PHXStringBuffer + href: com/phoenix_int/aserver/util/PHXStringBuffer.md + - name: PHXStringReplacer + href: com/phoenix_int/aserver/util/PHXStringReplacer.md + - name: PHXStringTokenizer + href: com/phoenix_int/aserver/util/PHXStringTokenizer.md + - name: scriptwrapper items: - - name: Package Summary - href: com/phoenix_int/aserver/util/package-summary.md - - name: Package Tree - href: com/phoenix_int/aserver/util/package-tree.md - - name: IPHXLineStore - href: com/phoenix_int/aserver/util/IPHXLineStore.md - - name: IPHXStringReplacer - href: com/phoenix_int/aserver/util/IPHXStringReplacer.md - - name: Parser - href: com/phoenix_int/aserver/util/Parser.md - - name: Parser.Mode - href: com/phoenix_int/aserver/util/Parser.Mode.md - - name: PHXClassNotFoundException - href: com/phoenix_int/aserver/util/PHXClassNotFoundException.md - - name: PHXFileLoader - href: com/phoenix_int/aserver/util/PHXFileLoader.md - - name: PHXFileName - href: com/phoenix_int/aserver/util/PHXFileName.md - - name: PHXFileParser - href: com/phoenix_int/aserver/util/PHXFileParser.md - - name: PHXGetByUrlException - href: com/phoenix_int/aserver/util/PHXGetByUrlException.md - - name: PHXIcon - href: com/phoenix_int/aserver/util/PHXIcon.md - - name: PHXNameDivider - href: com/phoenix_int/aserver/util/PHXNameDivider.md - - name: PHXNoSuchReplacementException - href: com/phoenix_int/aserver/util/PHXNoSuchReplacementException.md - - name: PHXNoSuchTokenException - href: com/phoenix_int/aserver/util/PHXNoSuchTokenException.md - - name: PHXProcess - href: com/phoenix_int/aserver/util/PHXProcess.md - - name: PHXProcessInfo - href: com/phoenix_int/aserver/util/PHXProcessInfo.md - - name: PHXRuntime - href: com/phoenix_int/aserver/util/PHXRuntime.md - - name: PHXStringBuffer - href: com/phoenix_int/aserver/util/PHXStringBuffer.md - - name: PHXStringReplacer - href: com/phoenix_int/aserver/util/PHXStringReplacer.md - - name: PHXStringTokenizer - href: com/phoenix_int/aserver/util/PHXStringTokenizer.md - - name: scriptwrapper + - name: api items: - - name: api - items: - - name: Package Summary - href: com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.md - - name: Package Tree - href: com/phoenix_int/aserver/util/scriptwrapper/api/package-tree.md - - name: AbstractFile - href: com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md - - name: CAEOutputFile - href: com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md - - name: InputFile - href: com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md - - name: IPHXRange - href: com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md - - name: IPHXRangeChangeListener - href: com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.md - - name: OutputFile - href: com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md - - name: OutputFile2 - href: com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md - - name: ParseableFile - href: com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md - - name: ParseableFile.Mode - href: com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md - - name: PHXBookmark - href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md - - name: PHXBookmarkNotFoundException - href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md - - name: PHXCAERange - href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md - - name: PHXRowFieldFile - href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md - - name: PHXRowFieldRange - href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md - - name: PHXRunShareContext - href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.md - - name: PHXScriptWrapperAPIException - href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md - - name: PHXScriptWrapperObject - href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md - - name: PHXSection - href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md - - name: PHXSectionNotFoundException - href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md - - name: PHXVersionException - href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md - - name: XPathFile - href: com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md + - name: Package Summary + href: com/phoenix_int/aserver/util/scriptwrapper/api/package-summary.md + - name: Package Tree + href: com/phoenix_int/aserver/util/scriptwrapper/api/package-tree.md + - name: AbstractFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/AbstractFile.md + - name: CAEOutputFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/CAEOutputFile.md + - name: InputFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/InputFile.md + - name: IPHXRange + href: com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRange.md + - name: IPHXRangeChangeListener + href: com/phoenix_int/aserver/util/scriptwrapper/api/IPHXRangeChangeListener.md + - name: OutputFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile.md + - name: OutputFile2 + href: com/phoenix_int/aserver/util/scriptwrapper/api/OutputFile2.md + - name: ParseableFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.md + - name: ParseableFile.Mode + href: com/phoenix_int/aserver/util/scriptwrapper/api/ParseableFile.Mode.md + - name: PHXBookmark + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmark.md + - name: PHXBookmarkNotFoundException + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXBookmarkNotFoundException.md + - name: PHXCAERange + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXCAERange.md + - name: PHXRowFieldFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldFile.md + - name: PHXRowFieldRange + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXRowFieldRange.md + - name: PHXRunShareContext + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXRunShareContext.md + - name: PHXScriptWrapperAPIException + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperAPIException.md + - name: PHXScriptWrapperObject + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXScriptWrapperObject.md + - name: PHXSection + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXSection.md + - name: PHXSectionNotFoundException + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXSectionNotFoundException.md + - name: PHXVersionException + href: com/phoenix_int/aserver/util/scriptwrapper/api/PHXVersionException.md + - name: XPathFile + href: com/phoenix_int/aserver/util/scriptwrapper/api/XPathFile.md + - name: com/phoenix_int/util items: - name: Package Summary diff --git a/2025R2/system-coupling-2025-r2/articles/docfx.json b/2025R2/system-coupling-2025-r2/articles/docfx.json index cae8d03493..5edd7f9cc6 100644 --- a/2025R2/system-coupling-2025-r2/articles/docfx.json +++ b/2025R2/system-coupling-2025-r2/articles/docfx.json @@ -6,7 +6,8 @@ "version": "2025 R2", "product": "System Coupling", "programming language": "C,C++,Fortran,Python", - "physics": "Multiphysics" + "product collection": "Multiphysics, Structures, Fluids", + "physics": "Multiphysics, Structures, Fluids" } } } diff --git a/2025R2/system-coupling-commands-25-r2/SyCCommands.md b/2025R2/system-coupling-commands-25-r2/SyCCommands.md new file mode 100644 index 0000000000..19d4ea1a2d --- /dev/null +++ b/2025R2/system-coupling-commands-25-r2/SyCCommands.md @@ -0,0 +1,1499 @@ +# System Coupling Commands + +This document provides detailed information on the commands you can use to interact with System Coupling from the command line, whether from System Coupling's command-line interface (CLI) or from the **Command Console** tab of its graphical user interface (GUI). + +--- + +## `AddAerodampingDataTransfers` + +### Description + +Adds data transfer for each specified mode shape. + +Returns the name of the Data Transfers created. + +### Essential Keyword Arguments + +- **Interface**: String indicating the name of the interface on which the data transfer +is to be created. + +### Optional Keyword Arguments + +- **ModeShapes**: List of mode shapes to transfer. If not provided, a +data transfer is created for each available modeshape. + +### Example + +```python +#Add a group of data transfers for aerodamping physics: +>>> AddAerodampingDataTransfers(Interface = "Interface-1", ModeShapes = ['ModeShape_Mode1_HI1', 'ModeShape_Mode3_HI2']) +['ModeShape_Mode1_HI1', 'ModeShape_Mode3_HI2'] +``` + +## `AddDataTransfer` + +### Description + +Adds data transfer based on arguments that specify the interface, target +side, and variables to be associated with each side of the interface. +The command requires that you specify variables using their names, as +described below in Essential Keyword Arguments. Either a variable-based or +expression-based data transfer may be created with this command based on +the Optional Keyword Arguments. If a variable-based data transfer argument +is given, then no expression-based data transfer arguments can be used. If +an expression-based data transfer argument is given, then no variable-based +data transfer arguments can be used. + +Cannot be run after participants have been started. + +Returns the name of the Data Transfer created. + +### Essential Keyword Arguments + +- **Interface**: String indicating the name of the interface on which the data transfer +is to be created. +- **TargetSide**: String indicating the side of the interface to receive the data +transfer variable. Possible values are 'One' or 'Two'. + +### Optional Keyword Arguments + +- **SourceVariable**: String specifying the name of the variable on the source side of +the data transfer. Used when creating a variable-based data transfer. +Must be combined with TargetVariable. +- **TargetVariable**: String specifying the name of the variable on the target side of +the data transfer. Must be combined with either SourceVariable (when +creating a variable-based data transfer) or with Value{X|Y|Z} +(when creating an expression-based data transfer). +- **Value**: String specifying the expression to use on the source side of the data +transfer. Used when creating an expression-based data transfer. If the +TargetVariable is a vector, a vector-valued expression must be provided. +Alternatively, ValueX, ValueY, ValueZ may be used to specify the +individual components of the vector expression. +- **ValueX**: String specifying the X component of the expression to use on the +source side of the data transfer. This may optionally be used when creating +an expression-based data transfer if the TargetVariable is a vector as an +alternative to specifying a vector-valued expression in Value. ValueY and +ValueZ are also required if ValueX is used. +- **ValueY**: String specifying the Y component of the expression to use on the +source side of the data transfer. This may optionally be used when creating +an expression-based data transfer if the TargetVariable is a vector as an +alternative to specifying a vector-valued expression in Value. ValueX and +ValueZ are also required if ValueY is used. +- **ValueZ**: String specifying the Z component of the expression to use on the +source side of the data transfer. This may optionally be used when creating +an expression-based data transfer if the TargetVariable is a vector as an +alternative to specifying a vector-valued expression in Value. ValueX and +ValueY are also required if ValueZ is used. +- **SideOneVariable**: String specifying the name of the variable associated with side1 +of the interface. Must be combined with SideTwoVariable. Used only +when creating variable-based data transfers. Consider using +SourceVariable/TargetVariable parameters instead. +- **SideTwoVariable**: String specifying the name of the variable associated with side2 +of the interface. Must be combined with SideTwoVariable. Used only +when creating variable-based data transfers. Consider using +SourceVariable/TargetVariable parameters instead. + +### Examples + +#### Example 1 + +```python +#Add a variable-based data transfer: +>>> AddDataTransfer(Interface = "Interface-1", +TargetSide = "One", +SourceVariable = "force", +TargetVariable = "FORC") +``` + +#### Example 2 + +```python +#Add an expression-based data transfer: +>>> AddDataTransfer(Interface = "Interface-1", +TargetSide = "One", +TargetVariable = "Temperature", +Value = "300 [K] if Step < 3 else temperature") +``` + +#### Example 3 + +```python +#Add an expression-based vector data transfer: +>>> AddDataTransfer(Interface = "Interface-1", +TargetSide = "One", +TargetVariable = "INCD", +Value = "vector( +INCD * Position.x / 1 [m], +INCD * Position.y / 0.5 [m], +INCD * Position.z / 0.02 [m])") +``` + +## `AddExpressionFunction` + +### Description + +Creates an expression function object in the data model that makes +available an external Python function for use in expressions. + +The parameters specified should correspond to a module and function +that exists and can successfully be loaded when the application +starts. Otherwise, the data model object will be created but there +will be validation errors and the function will not be available for +use. + +### Essential Keyword Arguments + +- **Module**: The name of the Python module (in the 'Modules' sub-directory of +the working directory) from which the function is to be obtained. +- **Function**: The name of the function in the module. If no FunctionName is +specified, this will also be the name by which the function should +be referenced when used in an expression. + +### Optional Keyword Arguments + +- **FunctionName**: Optionally specify a different name from Function which should be +the name used to reference the function in an expression. + +### Examples + +#### Example 1 + +```python +#If the parameters are valid, 'f' is available to be referenced with +#appropriate arguments in an expression - e.g. "2 * f(Time)". +>>>AddExpressionFunction(Module='my_module', Function='f') +``` + +#### Example 2 + +```python +#If the parameters are valid, 'f1' is available to be referenced with +#appropriate arguments in an expression - e.g. "2 * f1(Time)". +>>>AddExpressionFunction(Module='my_module', Function='f', FunctionName='f1') +``` + +## `AddFSIDataTransfers` + +### Description + +Adds group of data transfers for FSI physics. + +Returns the list of the data transfers created. + +### Essential Keyword Arguments + +- **Interface**: String indicating the name of the interface on which the data transfer +is to be created. + +### Optional Keyword Arguments + +- **UseForceDensity**: Boolean indicating whether to prefer force density variable over force. Default value is False. + +### Example + +```python +#Add a group of data transfers for FSI physics: +>>> AddFSIDataTransfers(Interface = "Interface-1") +['FORC', 'displacement'] +``` + +## `AddFlowBoundaryDataTransfers` + +### Description + +Adds group of data transfers for flow boundary coupling. + +Returns the list of the data transfers created. + +### Essential Keyword Arguments + +- **Interface**: String indicating the name of the interface on which the data transfer +is to be created. + +### Example + +```python +#Add a group of data transfers for flow boundary coupling: +>>> AddFlowBoundaryDataTransfers(Interface = "Interface-1") +['mass-flow-rate', 'backflow-total-temperature'] +``` + +## `AddInterface` + +### Description + +Adds an interface based on the participant and region names specified +as arguments for each side of the interface. This command requires that +you specify participants using their names as described below in +Essential Keyword Arguments. Non-FMU participants can provide a list +of regions as described below in Optional Keyword Arguments. For FMU +interfaces, specifying the regions are not allowed. + +Cannot be run after participants have been started. + +Returns the name of the Interface created. + +### Essential Keyword Arguments + +- **SideOneParticipant**: String indicating the name of the participant to be associated with +side One of the interface. +- **SideTwoParticipant**: String indicating the name of the participant to be associated with +side Two of the interface. + +### Optional Keyword Arguments + +- **SideOneRegions**: List specifying the name(s) of region(s) to be added to side One of +the interface. Must be provided if SideOneParticipant is not an FMU. +- **SideTwoRegions**: List specifying the name(s) of region(s) to be added to side Two of +the interface. Must be provided if SideOneParticipant is not an FMU. + +### Examples + +#### Example1 + +```python +#Create interface by specifying participant name and region names for each +#side of the interface. +>>> AddInterface(SideOneParticipant = "MAPDL-1", +SideOneRegions = ["FSIN_1"], +SideTwoParticipant = "FLUENT-2", +SideTwoRegions = ["wall"]) +``` + +#### Example2 + +```python +#Create an interface between an FMU and a non-FMU participant. +>>> AddInterface(SideOneParticipant = "MAPDL-1", +SideOneRegions = ["FSIN_1"], +SideTwoParticipant = "FMU-2") +``` + +## `AddNamedExpression` + +### Description + +Creates a named expression object in the data model. +If there is already an object in the data model whose 'ExpressionName' +matches the provided ExpressionName, its 'ExpressionString' will be +overwritten with the provided ExpressionString + +### Essential Keyword Arguments + +- **ExpressionName**: The name by which this expression should be referenced when used in +another expression. +- **ExpressionString**: String containing the definition of the expression. + +### Example + +```python +#create a named expression called 'twoPi' that evaluates to 2 * pi: +>>>AddNamedExpression(ExpressionName='twoPi', ExpressionString='2 * pi') +#'twoPi' is now available to be referenced in any other expression. +``` + +## `AddOrderedDataTransfers` + +### Description + +Adds data transfer for each ordered pair of variables in an +FMU-FMU interface. Requires the FMU-FMU interface. Requires +that the target FMU has the same number of input variables +as the source FMU has output variables. +The transfers are added in order. That is, the n-th output +variable for side one will be connected to the n-th input +variable for side two. This is only available for interfaces +with FMUs on both side one and side two. + +Data transfers will be created in both directions, if possible. + +Returns the name of the data transfers created. + +### Essential Keyword Arguments + +- **Interface**: String indicating the name of the interface on which the data transfer +is to be created. + +### Example + +```python +#Add a group of ordered data transfers for an FMU-FMU interface: +>>> AddOrderedDataTransfers(Interface = "Interface-1") +['Real_1', 'Real_2', 'Real_3'] +``` + +## `AddParticipant` + +### Description + +Adds a coupling participant to the setup. +Cannot be called after participants have been started. +Returns the name of the participant. + +There are several options that can be selected to add the +participant - via a file, via a participant executable, or via a +Python script. Some of these options may be combined. For example, +sometimes it is useful to use an input file while at the same time +providing a custom participant executable or Python script. + +Option 1: Using an input file + +Given an input file containing participant coupling information, reads the +specified file, pushes the participant's information to the data model. + +Option 2: Using a participant executable + +Given the path to the executable for this participant (and optionally, +additional arguments and/or working directory), start the participant +executable, connect to the participant using the socket connection, +and get the participant's information and add it to the data model. + +Option 3: Using a Python script + +This can be seen as a special case of Option 2 (using an executable), +but instead of an executable, a Python script is used. System Coupling +will invoke a specialized script to set up the environment so +that the Python script can more easily interact with System Coupling. + +### Optional Keyword Arguments + +- **ParticipantType**: Participant type. To get a list of supported participant types, use +the GetSupportedParticipantTypes() query. If unspecified, +AddParticipant will attempt to deduce the type from InputFile. +- **InputFile**: Name of the input file for the participant to be added. +Currently supported formats are SCP files, Forte input (FTSIM) +files, mechanical server (*.rst) files, cfd server (*.csv) files, +FMU (.fmu) files (Beta), and system coupling data server (*.scdt/axdt/csv) files. +- **Executable**: Path to the executable file for the participant to be added. +- **AdditionalArguments**: Any additional arguments to be passed to the participant's executable. +- **WorkingDirectory**: Path to the working directory for this participant. +- **PythonScript**: Instead of the executable, use a Python script and wrap it with +System Coupling-provided .bat/.sh scripts to set up the environment +correctly before calling this Python script. On Windows, a few +lines will need to be included near the top of the Python script to +add the required dll directories as follows: +if sys.platform.startswith("win"): + for p in os.environ["PYTHON_DLL_PATH"].split(os.pathsep): + os.add_dll_directory(p) + +### Examples + +#### Example1 + +```python +#Add a participant to a coupled analysis via an input file: +>>> AddParticipant(InputFile = "MAPDL.scp") +``` + +#### Example2 + +```python +#Add a participant to a coupled analysis via an executable: +>>> AddParticipant(Executable = "participantSolver.bat") +``` + +#### Example3 + +```python +#Add a participant to a coupled analysis via a Python script: +>>> AddParticipant(PythonScript = "participantSolver.py") +``` + +#### Example4 + +```python +#Add a participant to a coupled analysis via a Python script and +#an SCP file: +>>> AddParticipant(InputFile = "setup.scp", +PythonScript = "participantSolver.py") +``` + +## `AddReferenceFrame` + +### Description + +Add a reference frame to the datamodel + +The function will add a blank reference frame to the datamodel. Any +transformations must be added separately. + +Reference frame name will be "Frame-#" where # is the first positive +integer which yields a unique frame name. + +Returns the name of the reference frame. + +### Optional Keyword Arguments + +- **ParentReferenceFrame**: Name of a reference frame that the added frame should use as the +parent. If the argument is not provided, the default parent reference +frame "GlobalReferenceFrame" will be added. + +### Example + +```python +#Add a reference frame with a parent reference frame: +>>> AddReferenceFrame(ParentReferenceFrame = "Frame-3") +'Frame-4' +``` + +## `AddThermalDataTransfers` + +### Description + +Adds group of data transfers for thermal physics. + +Returns the list of the data transfers created. + +### Essential Keyword Arguments + +- **Interface**: String indicating the name of the interface on which the data transfer +is to be created. + +### Optional Keyword Arguments + +- **Option**: Thermal data transfer option: 'Heat Rate' (default) or +'Heat Transfer Coefficient' (possible for surface-surface transfers). + +### Example + +```python +#Add a group of data transfers for thermal physics: +>>> AddThermalDataTransfers(Interface = "Interface-1", Option = 'HeatRate') +['temperature', 'HFLW'] +``` + +## `AddTransformation` + +### Description + +Add a transformation to a reference frame defined in the datamodel + +Given the reference frame to add to the transform to, the type of transform +to be added, and any required information for the transformation, add the +transformation to the referenceFrame. Not all parameters are required for +every transformation. + +The name of the transformation will be based on the type of transformation. +The name will be of the form "-#" where # is the first +positive integer which yields a unique frame name. + +The transformation will also be added to the end of the TransformationOrder +list for the reference frame. + +Returns the name of the transformation. + +### Essential Keyword Arguments + +- **ReferenceFrame**: Name of the reference frame to which the transformation will be added. +- **TransformationType**: Type of transformation to be added. Available options are Rotation or +Translation + +Required Parameters for Transformation Types: + Rotation: Angle, Axis, Vector (if Axis is "UserDefined") + Translation: Vector + +### Optional Keyword Arguments + +- **Angle**: Angle to rotate a reference frame. Used with Rotation +TransformationType. Default unit is Radians. +- **Axis**: Axis about which a rotation is applied. Used with +Rotation TransformationType. Available options are: "XAxis", "YAxis", +"ZAxis", and "UserDefined". +- **Vector**: A vector for use with Translation TransformationType or Rotation +TransformationType if the Axis is "UserDefined". + +### Example + +```python +#Add a translation transformation to a reference frame: +>>> AddTransformation( +ReferenceFrame = "Frame-1", +TransformationType = "Rotation", +Axis = "XAxis", +Angle = "7 [deg]") +'Rotation-3' +``` + +## `ClearState` + +### Description + +Clears the state of the entire System Coupling service, removing all +data model items, parameter values, and calculated values. + +Cannot be run after participants have been started. + +## `ConnectEnSightDVS` + +### Description + +Allow System Coupling to create DVS clients and connect these clients to +the dvs server that is already launched in another process/thread remotely. + +When this command is issued, System Coupling is connected to remote EnSight +and the in-situ data streaming from system coupling to EnSight is ready. + +### Optional Keyword Arguments + +- **Port**: DVS Server port that System Coupling would connect to. Default value is 50055. +- **HostName**: DVS Server host name that System Coupling would connect to. Default value is "127.0.0.1". + +### Example + +```python +#Connect to EnSight DVS server launched in the machine with the +#above host name and port number. +>>> ConnectEnSightDVS(Port=50055,HostName="127.0.0.1") +``` + +## `CreateNamedExpression` + +### Description + +Important: this command is deprecated and will be removed in a future +release. The command AddNamedExpression has identical functionality +and should be used instead. + +Creates a named expression object in the data model. +If there is already an object in the data model whose 'ExpressionName' +matches the provided ExpressionName, its 'ExpressionString' will be +overwritten with the provided ExpressionString. + +### Essential Keyword Arguments + +- **ExpressionName**: The name by which this expression should be referenced when used in +another expression. +- **ExpressionString**: String containing the definition of the expression. + +### Example + +```python +#create a named expression called 'twoPi' that evaluates to 2 * pi: +>>>CreateNamedExpression(ExpressionName='twoPi', ExpressionString='2 * pi') +#'twoPi' is now available to be referenced in any other expression. +``` + +## `CreateRestartPoint` + +### Description + +Interactive command that creates a restart point at the end of the +last completed coupling step. + +Signals the System Coupling service and all coupling participants that a +restart point should be created before the next coupling step begins. The +restart point is created in addition to restart points created by the +'OutputControl' setting in the data model. + +Note that some participants write their restart files only when the +coupling run resumes, so their files will not be available immediately +after the command is issued. + +Results information for the coupling step is written to a file named +according to the convention "Results_step<#>|iter<#>.h5", where "#" is the number of +the coupling step or iteration. The restart files are written to the "SyC" +directory, which is automatically created by System Coupling. + +## `DeleteObject` + +### Description + +Deletes the specified object from the data model. + +### Essential Keyword Arguments + +- **ObjectPath**: String indicating the path of the object to be deleted. + +### Example + +```python +#Delete an interface object from the data model +>>> DeleteObject(ObjectPath = '/SystemCoupling/CouplingInterface: +interface-1') +``` + +## `DeleteSnapshot` + +### Description + +Deletes the specified snapshot. +If the snapshot does not exist, an error will +be raised. + +### Essential Keyword Arguments + +- **SnapshotName**: Name of the snapshot to be deleted. + +### Example + +```python +#Delete a snapshot called 'Initial' +>>> DeleteSnapshot(SnapshotName='Initial') +``` + +## `DeleteTransformation` + +### Description + +Delete a transformation from a reference frame + +In addition to deleting the transformation object, it will also remove the +transformation from TransformationOrder (if it exists in that list). + +### Essential Keyword Arguments + +- **ReferenceFrame**: Name of the reference frame from which the transformation will be +deleted. +- **TransformationName**: Name of the transformation which will be deleted. + +### Example + +```python +#Delete a transformation from a reference frame: +>>> DeleteTransformation( +ReferenceFrame = "Frame-1", +TransformationName = "Rotation-3") +``` + +## `ExecuteCommandString` + +### Description + +Executes a command in the Python interpreter, enabling you to issue a +generic Python command to the System Coupling Service. + +### Essential Keyword Arguments + +- **CommandString**: String indicating the command to be executed. + +### Example + +```python +#Execute a command string to print the state of a singleton +>>> ExecuteCommandString(CommandString = 'DatamodelRoot() +.OutputControl.PrintState()') +OutputControl +Option = LastStep +``` + +## `GenerateInputFile` + +### Description + +Generates the input journal file for a given Fluent participant. + +Available for Fluent participants when FluentInput.Option is not +set to JournalFile. + +Given the participant's name and a file name, generates a Fluent +journal script which may be set as the value for the JournalFile +setting. + +System Coupling uses the generated scrkpt for the coupled analysis. + +Scripts generated using this method may be edited before the +coupled analysis is started. + +### Essential Keyword Arguments + +- **ParticipantName**: Name of the participant for which the execution command will +be returned. +- **FileName**: Name of the journal script to be written. Note that this name is relative +to the participant's working directory. + +### Example + +```python +#Get a participant's execution command +>>> GenerateInputFile(ParticipantName = 'FLUENT-1', FileName = 'fluent.jou') +``` + +## `GetErrors` + +### Description + +If errors exist, returns them as a list of dictionaries containing error +details; otherwise, returns an empty list. See also: GetErrorsXML(). + +## `GetExecutionCommand` + +### Description + +Gets the execution command needed to start the specified participant. + +### Essential Keyword Arguments + +- **ParticipantName**: Name of the participant for which the execution command will +be returned. + +### Example + +```python +#Get a participant's execution command +>>> GetExecutionCommand(ParticipantName = 'MAPDL-1') +'"C:\Program Files\ANSYS Inc\v261\ansys\bin\winx64\ANSYS252.exe" +-b nolist -s noread -o MAPDL-1.out -scport 55122 +-schost 127.0.0.1 -scname "MAPDL-1" -i ds.dat' +``` + +## `GetRegionNamesForParticipant` + +### Description + +This query is deprecated and will be deleted in future releases. +To get region names for a participant, you can use GetChildNames() +query, for example: + +DatamodelRoot().CouplingParticipant[name].Region.GetChildNames() + +### Essential Keyword Arguments + +- **ParticipantName**: Name of the participant. + +## `GetTransformation` + +### Description + +Given an interface and side, returns the resultant transformation, in +the form of a Python dictionary and formatted as a DataModel +ReferenceFrame object. If multiple transformations are applied to the +interface side, the composite transformation is returned. + +This command can only be invoked after the analysis +is initialized. + +### Essential Keyword Arguments + +- **InterfaceName**: Name of the interface +- **Side**: Interface side. Can be "One" or "Two". + +### Example + +```python +#Get the transformation for an interface side: +>>> t = GetTransformation(InterfaceName = "Interface-1", Side = "One") +``` + +## `ImportSystemCouplingInputFile` + +### Description + +Reads the specified System Coupling SCI file and pushes its information +into the data model. The SCI file is the required System Coupling input +format for the initial run of a coupled analysis set up in Workbench. + +After the initial run based on an imported SCI file, a reissue +of the ImportSystemCouplingInputFile command is unnecessary and is +not recommended unless the setup has changed. + +Cannot be run after participants have been started. + +### Essential Keyword Arguments + +- **FilePath**: Path and file name for the SCI file to be read. + +### Example + +```python +#Import an SCI file for an initial run +>>> ImportSystemCouplingInputFile(FilePath = 'scInput.sci') +``` + +## `Initialize` + +### Description + +Interactive command that initializes a coupled analysis. + +Initialization includes preparing System Coupling, making connections +between System Coupling and all participants, starting participants (if +necessary), and writing participant build information to the Transcript +and Log. + +Note that if the ExecutionControl Option for a participant is set to +ExternallyManaged, then System Coupling will not start the participant +using either this command or any of the other commands that automatically +start participants. The user is expected to manually start the participant. +This function will not return until all participants have been connected. + +Note that this command will raise an exception if another instance of +System Coupling is solving in the current working directory. + +## `Map` + +### Description + +Command to perform map operation. + +When user friendly mapping workflow is enabled, this command will perform +the map operation between the interfaces as part of the user friendly mapping +workflow. +Otherwise, this operation would clears all existing state, except for datamodel, +before beginning the operation. + +## `Open` + +### Description + +Reads the state of a coupled analysis. The state consists of settings to +populate the datamodel and results to restart the analysis at the end of +a specified coupling step. + +Settings are stored in a file named Settings.h5. Results files may +correspond either to coupling iterations or coupling steps, depending on +the analysis type and the types of participants involved. + +By default, this command looks for the "SyC" directory in the current +working directory. By default, if multiple Results files exist, the +most recent one is opened. + +If given optional arguments, behaves as described below in "Optional +Keyword Arguments". + +Cannot be run after the participants have been started. + +### Optional Keyword Arguments + +- **FilePath**: Directory containing the .h5 file(s) to be read. When used, the +System Coupling Service looks for files in the specified directory. +Default is 'SyC'. It is recommend to not use anything other than +a default directory for the FilePath. +- **CouplingStep**: Integer specifying the coupling step at which the coupled analysis is +restarted. When used, System Coupling reads the corresponding +Results_step<#>.h5 file in the specified directory and restarts the +analysis at the end of the specified coupling step. When this argument +is used, System Coupling automatically removes the output files related +to all later coupling steps. If the files cannot be removed, then +System Coupling generates an exception message instructing you to free +up the files and reissue the Open command with the CouplingStep +argument. If the simulation's Results files are associated with +coupling iterations, then System Coupling prints an error message +indicating this. +- **CouplingIteration**: Integer specifying the coupling iteration at which the coupled analysis +is restarted. When used, System Coupling reads the corresponding +Results_iter<#>.h5 file in the specified directory and restarts the +analysis at the end of the specified coupling iteration. When this +argument is used, System Coupling automatically removes the output +files related to all later coupling iterations. If the files cannot be +removed, then System Coupling generates an exception message +instructing you to free up the files and reissue the Open command with +the CouplingIteration argument. If the simulation's Results files are +associated with coupling steps, then System Coupling prints an error +message indicating this. + +### Examples + +#### Example 1 + +```python +#Load the last solved coupling step +>>> Open() +``` + +#### Example 2 + +```python +#Load coupling step 6 +>>> Open(CouplingStep = 6) +``` + +#### Example 3 + +```python +#Load coupling iteration 7 +>>> Open(CouplingIteration = 7) +``` + +## `OpenResultsInEnSight` + +### Description + +Allows for System Coupling results to be postprocessed in EnSight. + +When this command is issued, System Coupling looks for the Results.enc +file in the SyC/Results subdirectory of the current working directory. + +When System Coupling finds the file, it loads the file into EnSight and +generates a confirmation message indicating that results are being opened. + +If System Coupling is unable to find the Results.enc file and/or the +EnSight executable, then it raises an error. + +The OpenResultsInEnSight command may be issued multiple times from the same +instance of System Coupling. Each time the command is issued, a new +instance of the EnSight application is opened. Any existing instances of +EnSight remain open, both when additional instances are created and when +System Coupling exits. + +### Optional Keyword Arguments + +- **FileName**: The basename of the EnSight case file if using a non-standard file +name. Overrides the default file name "Results". +- **FilePath**: The path to the EnSight case if using a non-standard location. +Overrides the default path of SyC/Results. + +### Example + +```python +#Open results in EnSight using the default file name and path: +>>> OpenResultsInEnSight() +"Results are being opened in EnSight" +``` + +## `OpenSnapshot` + +### Description + +Opens a snapshot containing a previously saved state of the simulation. +All state (files and directories) stored in the snapshot will be restored. +If other state exists in the working directory, then it will not be +modified by this command. + +Note: Snapshot cannot be opened if participants have been started. + +### Optional Keyword Arguments + +- **SnapshotName**: The name of the snapshot to be opened. This is optional if and only if +there is only one snapshot available to be loaded. If multiple +snapshots exist, then the snapshot name must be specified. + +### Example + +```python +#Open a snapshot called 'InitialState' +>>> OpenSnapshot(SnapshotName='InitialState') +``` + +## `PartitionParticipants` + +### Description + +Provide a utility for setting the parallel algorithm, parallel partitioning +fractions for each participant, and machine list information. + +At least one participant must be defined for this command to be used. Use +of this command is not recommended if participants are already running. + +Note: +Ansys recommends only using this command for the Custom partitioning algorithm. + +When other algorithms are used (SharedAllocateMachines, +DistributedAllocateCores, etc.) the algorithm should be specified directly, +for example: + +DatamodelRoot().AnalysisControl.PartitioningAlgorithm = "SharedAllocateMachines" + +The participant parallel fractions can also be specified directly, for example: + +DatamodelRoot().CouplingParticipant["FLUENT-1"].ExecutionControl.ParallelFraction = 0.5 + +The machine list should be specified via System Coupling command line arguments, +for example: + +/SystemCoupling/binsystemcoupling --cnf="hostA:4,hostB:4" + +### Optional Keyword Arguments + +- **AlgorithmName**: Name of the partitioning algorithm. Available algorithms are: +'SharedAllocateMachines'(default), 'SharedAllocateCores', +'DistributedAllocateMachines', 'DistributedAllocateCores', +and 'Custom' (please see PartitioningInfo section below for more details +for this algorithm). The algorithms allow for both shared and distributed execution and for +the allocation of machines or cores. The default value is generally the +best choice, as it allows for each participant to take advantage of all +the allocated resources. The other partitioning methods are provided to +handle situations where not enough resources are available to run the +same machines. See the System Coupling documentation for more details of the +partitioning algorithms. +- **NamesAndFractions**: List of tuples specifying the fractions of core count applied for +each participant. Each tuple must have the ParticipantName as its first item and the +associated fraction as its second item. If this parameter is omitted, +then cores will be allocated for all participants set in the +data model. +- **MachineList**: List of dictionaries specifying machines available for distributed run. +Each dictionary must have a key 'machine-name' with machine name as its +value, and key 'core-count' with number of cores for that machine as +its value. Providing this argument will over-ride any machine-list +information detected from the scheduler environment and any information +provided by the --cnf command-line argument. +- **PartitioningInfo**: Dictionary specifying machines resources assigned to each participant by user. +Dictionary must have participant names as keys and machineLists containing +machine resources as values. The value of PartitioningInfo machineList is +a list of dictionaries specifying machines assigned to corresponding participants. +Each dictionary of machineList must have a key 'machine-name' with machine name +as its value, and key 'core-count' with number of cores for that machine as its value. +Providing this argument will disallow other arguments except AlgorithmName, +which must set as 'Custom' if provided. Otherwise, AlgorithmName will be set as +'Custom' internally if PartitioningInfo is provided. + +### Example + +```python +#Allocate machine resources for participants based on custom partitioning information. +#In this example, FLUENT-1 participant will run on machine "host-1" and "host-2" +#with 19 cores, and MAPDL-2 participant will run on machine "host-3" with 8 cores. +>>> PartitionParticipants( +PartitioningInfo={"FLUENT-1":[{"machine-name":"host-1","core-count":10}, +{"machine-name":"host-2","core-count":9}], +"MAPDL-2":[{"machine-name":"host-3","core-count":8}]}) +``` + +## `PrintExpressionVariables` + +### Description + +Given a path to an object, and a parameter name, print a list of +variables which can be used in an expression assigned to the +parameter. For convenience, as a special case, the parameter name may +be omitted if the path is to a DataTransfer object. + +If an expression cannot be used at the specified data model location, +or if there are no valid variables which can be used in the expression, +then no output will be printed. + +For the purposes of the command, "valid" means that the variable may be +used in the expression. Note however that "valid" does not necessarily mean +that a variable can be used in the expression. Other validation rules may +preclude the use of the variable. See the user documentation for more +details. + +For the DataTransfer case, the list of variables will be ordered with +the most likely variables first. That is, those sharing the same quantity +type and/or dimensionality as the target of the expression. + +### Essential Keyword Arguments + +- **ObjectPath**: String indicating the path of the object to print expression variables for. + +### Optional Keyword Arguments + +- **ParameterName**: String indicating the name of the parameter to print expression variables for. +Note: this is optional only if ObjectPath is a path to a DataTransfer object. + +### Example + +```python +#Get source side variables for a data transfer +>>> PrintExpressionVariables(ObjectPath = '/SystemCoupling/CouplingInterface:Interface-1/DataTransfer:Transfer-1') ++-----------------------------------------------------------------------------+ +| Available Variables | ++-----------------------------------------------------------------------------+ +| Variable | Tensor Type Dimension | ++-----------------------------------------------------------------------------+ +| Target | | +| Loss | (Scalar) [kg m^2 s^-3] | +| Source | | +| heatflow | (Scalar) [kg m^2 s^-3] | +| Position | (Vector) [m] | +| Normal | (Vector) [ ] | +| Area | (Scalar) [m^2] | +| Step | (Scalar) [ ] | +| Iteration | (Scalar) [ ] | +| Time | (Scalar) [s] | ++-----------------------------------------------------------------------------+ +``` + +## `PrintSetup` + +### Description + +Prints a summary of the System Coupling setup. + +## `PrintSnapshots` + +### Description + +Prints a list of available snapshots. + +### Example + +```python +#Print all available snapshots: +>>> PrintSnapshots() ++-------------------------------------------------------------------+ +| Available Snapshots | ++-------------------------------------------------------------------+ +| FinalState | +| Steps : 1, 3, 5 | +| Initial | +| Steps : | ++-------------------------------------------------------------------+ +``` + +## `ReadScriptFile` + +### Description + +Reads a script file in the command environment. + +### Essential Keyword Arguments + +- **FileName**: Name of the script file that is to be read. + +### Example + +```python +#Read a Python script file +>>> ReadScriptFile(FileName = 'run.py') +``` + +## `ReloadExpressionFunctionModules` + +### Description + +This may be called to force a reload of expression function modules +if they have changed since they were last loaded. + +## `Save` + +### Description + +Saves the state of the coupled analysis data model. + +Analysis settings are written to a single Settings.h5 file which +can be used to reload analysis settings. + +Restart files for all restart points in the current co-simulation will +be written when this command is called. Existing restart files from +previous System Coupling versions will be renamed to conform to the new +naming scheme. + +Restart files are named according to the convention +Restart_step#.h5 or Restart_iter#.h5, where "#" is the index of +the corresponding coupling step or iteration. + +Returns a Boolean value of 'True' if the files were saved successfully; +otherwise, returns a value of 'False'. + +Note that this command will raise an exception if another instance of +System Coupling is solving in the current working directory. + +If given optional arguments, then behaves as described below in "Optional +Keyword Arguments." + +### Optional Keyword Arguments + +- **FilePath**: Writeable directory to which the SyC directory is added. (Settings and +Results .h5 files will be written to the SyC directory.). Ansys does +not recommend changing the default value of this argument. + +### Example + +```python +#Save the state of a coupled analysis in a "SyC" directory under current +#working directory. +>>> Save() +True +``` + +## `SaveSnapshot` + +### Description + +Saves a snapshot of the current state of the simulation. Snapshot will +contain all files and directories within the working directory that are +tracked by System Coupling: the SyC directory and the working directories +of all loaded participants. Before saving the snapshot, the current +datamodel will be saved. + +Note: Snapshot cannot be saved if participants have been started. + +Note: If files required for cosimulation are not stored within the working +directory, then they will not be included in the snapshot. + +### Essential Keyword Arguments + +- **SnapshotName**: Name of the snapshot to be saved. + +### Optional Keyword Arguments + +- **OverwriteExisting**: Boolean argument controlling whether an existing snapshot should be +overwritten. If True, then an existing snapshot named SnapshotName will +be overwritten if it exists. If False (default), then if SnapshotName is +shared with an existing snapshot, a warning will be written and the +command will return without saving the snapshot. + +### Example + +```python +#Save a snapshot called 'InitialState' +>>> SaveSnapshot(SnapshotName='InitialState') +``` + +## `SetState` + +### Description + +Sets the state of a specified datamodel container (can be either a +singleton or an object). + +Returns a Boolean value of 'True' if the state was updated; +otherwise, returns a value of 'False'. (The latter would happen if +a value were set that is no different from the value already in the +state.) + +By default, System Coupling will allow settings to be made that are +not currently available in the datamodel, as long as they are settings +that are potentially available. They will not show up in the datamodel +if they are not currently available, but if the state is later adjusted +such that the settings become available, the values that were previously +set will be seen. + +This behavior can be controlled by the optional 'VerifyCommittedState' +argument. This will cause a check to be performed for submission of +unavailable settings, and an exception will be raised if the check fails. +Note that, despite the exception, the settings will remain committed. + +### Essential Keyword Arguments + +- **ObjectPath**: String indicating the path of the container to have its state set. +- **State**: Dictionary with the container state (settings) as keys and setting +values as values. + +### Optional Keyword Arguments + +- **VerifyCommittedState**: Boolean to control whether to check whether only settings that are +currently available have been submitted. If the check is performed and +it fails, an exception will be raised. + +### Examples + +#### Example 1 + +```python +#Use 'SetState' on a singleton +>>> SetState(ObjectPath = '/SystemCoupling/AnalysisControl/GlobalStabilization', +State = {'Option': 'Quasi-Newton'}) +True +``` + +#### Example 2 + +```python +#Using 'SetState' on an object +>>> SetState(ObjectPath = '/SystemCoupling/CouplingParticipant:MAPDL-1 +/Variable:FORC', State = {'QuantityType': 'Force', 'DisplayName': +'TestForce'} ) +True +``` + +## `Shutdown` + +### Description + +Interactive command that shuts down a coupled analysis. + +Shutdown includes ending the coupling run and signaling participants +to end the run. This produces a clean shutdown, generating the final +restart point and corresponding Results file before disconnecting +from participants. + +After participants are disconnected, the coupling service writes +timing details to the transcript. If participants were started +automatically, it ends participant processes. + +When System Coupling disconnects from the analysis and shuts down, the GUI +Server file is removed from the working directory. + +## `Solve` + +### Description + +Solves the coupled analysis. This command will execute until +end coupled analysis is reached, or it is interrupted or aborted +(for example, via scStop file). + +Disabled when a solution is already in progress. + +For restarts, the Open command must be run before the Solve command. + +Note that if the ExecutionControl Option for a participant is set to +ExternallyManaged, then System Coupling will not start the participant +using either this command or any of the other commands that automatically +start participants. The user is expected to manually start the participant. +This function will not return until all participants have been connected. + +Note that this command will raise an exception if another instance of +System Coupling is solving in the current working directory. + +## `Step` + +### Description + +Interactive command that initializes the analysis (if necessary) and +runs the specified number of coupling steps before pausing the coupled +analysis. + +Disabled when a solution is already in progress. + +Disabled for iterations-only steady analyses. + +By default, runs a single step. If given the optional 'Count' argument, +then runs the specified number of steps. + +For restarts, the 'Open' command must be run before the 'Step' command. + +When you run this command, System Coupling initializes the analysis if +needed and then begins the solution. When the specified number of coupling +steps has been run, the solution is paused, providing you with an +opportunity to interact with the analysis. + +Note that if the ExecutionControl Option for a participant is set to +ExternallyManaged, then System Coupling will not start the participant +using either this command or any of the other commands that automatically +start participants. The user is expected to manually start the participant. +This function will not return until all participants have been connected. + +When the solution is resumed, either by reissuing this command or by +running the Solve command, System Coupling restarts the analysis at the +point it left off and continues the solution with the next step. + +Note that this command will raise an exception if another instance of +System Coupling is solving in the current working directory. + +### Optional Keyword Arguments + +- **Count**: Integer specifying the number of steps to be run. Defaults to 1. + +### Examples + +#### Example 1 + +```python +#Use the default (the analysis runs one coupling step) +>>> Step() +``` + +#### Example 2 + +```python +#Specify that the analysis runs three coupling steps +>>> Step(Count = 3) +``` + +## `UpdateInterfaces` + +### Description + +Command to apply transformation and instance defined in the interfaces. +And display mapping mesh with the transformation and instance applied in the +System Coupling viewer. + +The purpose of this command is to visually confirm the correctness of coupling +interfaces definition, alignment and instancing settings, and to allow modifying +those settings to fix any issues ("nudge" the alignment, etc.) + +## `UpdateParticipant` + +### Description + +Given the name of a participant, updates the state of the participant. + +Available for DEFAULT-SRV, CFD-SRV, MECH-SRV, and SCDT-SRV and +AEDT participants. + +As part of the update, System Coupling updates all regions, variables, +and parameters defined in the participant, including all variable +attributes. Regions, variables, and parameters may be added to the +participant but may not be removed. + +You may specify an input file using an optional argument. If an input +file is not provided, then the original input file will be reimported. + +Note: AEDT participants must be updated using an scp file. + +If the update process fails, System Coupling displays an error. In this +case, you can either update the setup in the participant application to +remove any issues with the update process or delete the participant +from the analysis and then re-add it using the updated input file. + +### Essential Keyword Arguments + +- **ParticipantName**: Participant name. Must be the name of an existing participant. + +### Optional Keyword Arguments + +- **InputFile**: Name of the input file for the participant to be added. +Currently supported formats are SCP files, mechanical server +(*.rst) files, cfd server (*.csv) files, and system coupling +data server (*.scdt/axdt/csv) files. + +### Examples + +#### Example1 + +```python +#Update a participant: +>>> UpdateParticipant(ParticipantName = "MECH-SRV-1") +``` + +#### Example2 + +```python +#Update a participant using a new input file: +>>> UpdateParticipant(ParticipantName = "MECH-SRV-1", InputFile = "new.rst") +``` + +## `WriteCsvChartFiles` + +### Description + +For each coupling interface, exports a CSV file containing chart data +(convergence and source/target quantity transfer values) for +that interface. + +Each file is named according to the convention .csv, where + is the object name of the corresponding coupling interface. + +This command will overwrite any CSV charting files that already exist, +including any that were written during the solution. + +## `WriteEnSight` + +### Description + +Write a file with mesh and results which can be loaded into EnSight for +post processing. + +### Essential Keyword Arguments + +- **FileName**: Base name for EnSight files. It will generate .encas file which +should be loaded into EnSight. Other files are generated for geometry +and variables. + +### Optional Keyword Arguments + +- **Binary**: To control if file is to be written in binary format or ASCII. ASCII +slows down performance, but may be useful for debugging and seeing +raw data. + +### Examples + +#### Example 1 + +```python +#Write EnSight file with base name of 'test' +>>> WriteEnSight(FileName='test') +``` + +#### Example 2 + +```python +#Write EnSight file with base name of 'test' in ASCII +>>> WriteEnSight(FileName='test', Binary = False) +``` + +## `WriteTargetData` + +### Description + +Command to write target data for target participant after mapping operation. + +The purpose of this command is to write target mesh and target mapped data in +the target participant working directory and thus mapping results from SystemCoupling can +be check in the target participant. + +### Optional Keyword Arguments + +- **Overwrite**: Flag indicating whether to overwrite the existing target data file. Default value is False. + diff --git a/2025R2/system-coupling-commands-25-r2/docfx.json b/2025R2/system-coupling-commands-25-r2/docfx.json new file mode 100644 index 0000000000..7c2909f65c --- /dev/null +++ b/2025R2/system-coupling-commands-25-r2/docfx.json @@ -0,0 +1,13 @@ +{ + "build": { + "globalMetadata": { + "title": "System Coupling Commands 2025 R2", + "summary": "", + "version": "2025 R2", + "product": "System Coupling", + "programming language": "C,C++,Fortran,Python", + "product collection": "Multiphysics, Structures, Fluids", + "physics": "Multiphysics, Structures, Fluids" + } + } + } diff --git a/2025R2/system-coupling-commands-25-r2/index.md b/2025R2/system-coupling-commands-25-r2/index.md new file mode 100644 index 0000000000..9f7a877097 --- /dev/null +++ b/2025R2/system-coupling-commands-25-r2/index.md @@ -0,0 +1,4 @@ +# Introduction + +System Coupling provides a versatile set of commands that enable users to interact with it either through the command-line interface (CLI) or the **Command Console** tab in its graphical user interface (GUI). + diff --git a/2025R2/system-coupling-commands-25-r2/toc.yml b/2025R2/system-coupling-commands-25-r2/toc.yml new file mode 100644 index 0000000000..41947acc9a --- /dev/null +++ b/2025R2/system-coupling-commands-25-r2/toc.yml @@ -0,0 +1,4 @@ +- name: Introduction + href: index.md +- name: System Coupling Commands + href: SyCCommands.md