Magnetics: forme e unità

Prepara campi a tre componenti e griglie per MAGNETICS_API_v1. Usa forme, ordine delle componenti e unità coerenti con l’operazione.

Coordinate e campo

Coordinate e campi a tre componenti possono usare righe N×3. Su una griglia regolare per assi conserva le tre coordinate nel nodo cell e colloca le tre componenti nell’ultima dimensione del tensore vettoriale. Dichiara B in T, H in A/m, lunghezza in m, permeabilità in H/m ed energia in J; se il calcolo della sola norma parte da nT, la norma resta in nT.

Riferimento delle operazioni

Vai a un’operazione

Superfici riservate e facciate

  • ::GX::MagneticsAPIv1::apiInfo

    Regola di accesso
    REGISTERED_TYPED_ADAPTER
    Operazione pubblica
    api_info
    Condizioni d’uso
    Il modulo originale math.magnetics legge il descrittore, la versione e le capacità dell’installazione da un percorso fisso. L’adattatore api_info richiama direttamente questa funzione e mantiene tutti i campi, l’ordine delle capacità e la stringa originale della versione del fornitore. Applica la tipizzazione alla sola versione API dichiarata. I metadati describe del registro condiviso hanno un contratto distinto. La chiamata legge solo metadati dell’installazione.
  • ::GX::MagneticsAPIv1::call

    Regola di accesso
    REGISTERED_TYPED_ADAPTER
    Operazione pubblica
    call
    Condizioni d’uso
    La chiamata pubblica riceve family, action, a, b, c ed eventualmente options tipizzato. Controlla l’identificatore completo nella lista del modulo e usa ScientificTransportv1 con il kernel originario. Se ometti options si applica il valore Tcl predefinito. La chiamata restituisce tutti i campi previsti da resultTypes tramite il codec esistente, con componenti reali o complesse in binary64, forme e unità originali. Restano disponibili anche le chiamate per singola famiglia e azione. L’esecuzione in blocco di Signal segue il proprio percorso. Il risultato tipizzato documenta i dati restituiti dal trasporto. L’interfaccia grezza Tcl ha un proprio contratto.
  • ::GX::MagneticsAPIv1::listOperations

    Regola di accesso
    REGISTERED_TYPED_ADAPTER
    Operazione pubblica
    list_operations
    Condizioni d’uso
    L’operazione list_operations legge il TSV installato del modulo e restituisce i suoi identificatori esatti nell’ordine originario. Le chiavi di registrazione dello Script Bridge appartengono a un elenco distinto. Per Signal l’elenco originale aggiunge statistical_contract. operation_schema, validate_operation e gli adattatori hanno registrazioni separate. La chiamata rifiuta argomenti sconosciuti e legge i descrittori del modulo installato.
  • ::GX::MagneticsAPIv1::operationMetadata

    Regola di accesso
    REGISTERED_TYPED_ADAPTER
    Operazione pubblica
    operation_metadata
    Condizioni d’uso
    L’operazione operation_metadata cerca un ID effettivo nel TSV del modulo e unisce i metadati originali della famiglia e della guida. Per Signal mantiene il risultato completo di operationSchema, comprese le chiavi ui_field e final_scientific_checks. Restituisce i descrittori degli argomenti e i campi di esito nell’ordine originario. Conserva le stringhe di unità, valori predefiniti e limiti. Se l’ID è sconosciuto restituisce l’errore originale del modulo. L’operazione legge i metadati installati.

api_info

Accesso
registrata nel Job Python
Argomenti
[]
Esito
Risultato completo del modulo originale, restituito tramite il trasporto tipizzato esistente. Calcolo e provenienza restano quelli del modulo.
Funzione
Informazioni e capacità del modulo installato
gxtxt_api_call("MAGNETICS_API_v1", "api_info", args)
Risultato registrato · api_info

Scarica lo script dell’esempio (ZIP).

Operandi del caso, anteprima

[]

Esito, anteprima

{
  "api_id": "MAGNETICS_API_v1",
  "api_version": 1,
  "provider_id": "math.magnetics",
  "provider_version": "1.2.0",
  "capabilities": [
    "coordinates",
    "field",
    "integral",
    "constitutive",
    "circuit",
    "energy",
    "bh",
    "loss",
    "anisotropic_permeability",
    "nonlinear_bh"
  ]
}

list_operations

Accesso
registrata nel Job Python
Argomenti
[]
Esito
Risultato completo del modulo originale, restituito tramite il trasporto tipizzato esistente. Calcolo e provenienza restano quelli del modulo.
Funzione
Elenco ordinato delle operazioni del modulo
gxtxt_api_call("MAGNETICS_API_v1", "list_operations", args)
Risultato registrato · list_operations

Scarica lo script dell’esempio (ZIP).

Operandi del caso, anteprima

[]

Esito, anteprima

[
  "coordinates.cartesian_to_cylindrical",
  "coordinates.cylindrical_to_cartesian",
  "coordinates.cartesian_to_spherical",
  "coordinates.spherical_to_cartesian",
  "field.magnitude",
  "field.phasor",
  "field.normal_component",
  "field.sample",
  "field.gradient",
  "field.divergence"
]

operation_metadata

Accesso
registrata nel Job Python
Argomenti
operation
Esito
Risultato completo del modulo originale, restituito tramite il trasporto tipizzato esistente. Calcolo e provenienza restano quelli del modulo.
Funzione
Metadati dell’operazione richiesta
gxtxt_api_call("MAGNETICS_API_v1", "operation_metadata", args)
Risultato registrato · operation_metadata

Scarica lo script dell’esempio (ZIP).

Operandi del caso, anteprima

[
  "integral.surface_flux"
]

Esito, anteprima

{
  "id": "integral.surface_flux",
  "summary": "integral surface flux",
  "api_id": "MAGNETICS_API_v1",
  "api_version": 1,
  "operands": "geometry,field,connectivity,options",
  "input_shapes": "path_or_vertices_or_grid;field;triangles",
  "result_shapes": "scalar",
  "units": "field_unit_times_length_area_or_volume",
  "complex_behavior": "real_and_complex",
  "errors": "DimensionMismatch;InvalidGrid",
  "arguments": [
    "geometry",
    "field",
    "connectivity",
    "options"
  ],
  "argument_descriptors": [
    {
      "name": "geometry",
      "shape": "path_or_vertices_or_grid",
      "source": "cell,range,column,scalar,option"
    },
    {
      "name": "field",
      "shape": "field",
      "source": "cell,range,column,scalar,option"
    },
    {
      "name": "connectivity",
      "shape": "triangles",
      "source": "cell,range,column,scalar,option"
    },
    {
      "name": "options",
      "shape": "action-specific",
      "source": "cell,range,column,scalar,option"
    }
  ],
  "signature": "magnetics.integral.surface_flux(geometry, field, connectivity, options)",
  "worksheet_example": "Apply magnetics.integral.surface_flux using Worksheet ranges A1:A20 and B1:B20; set action-specific operands in the guided dialog.",
  "result_fields": [
    "scalar"
  ],
  "unit_behavior": "field_unit_times_length_area_or_volume"
}

call

Accesso
registrata nel Job Python
Argomenti
family, action, a, b, c, options
Esito
Risultato completo del modulo originale, restituito tramite il trasporto tipizzato esistente. Calcolo e provenienza restano quelli del modulo.
Funzione
Esecuzione dell’operazione indicata da famiglia e azione
gxtxt_api_call("MAGNETICS_API_v1", "call", args)
Risultato registrato · call

Scarica lo script dell’esempio (ZIP).

Operandi del caso, anteprima

[
  "circuit",
  "reluctance",
  {
    "kind": "array",
    "shape": [
      1,
      1
    ],
    "real": [
      1.0
    ]
  },
  {
    "kind": "array",
    "shape": [
      1,
      1
    ],
    "real": [
      0.01
    ]
  },
  {
    "kind": "array",
    "shape": [
      1,
      1
    ],
    "real": [
      1000
    ]
  }
]

Esito, anteprima

{
  "value_real": 79577.47154594767,
  "value_imaginary": 0.0,
  "unit": "A/Wb"
}