Magnetics operations
Search the Magnetics catalog and consult the inputs, results, and notes for the documented operations.
How to use this family
Choose the field or circuit model and the relevant units first. Use ordered H/B pairs for curves, geometric quantities for reluctances and the required material data. Field operations depend on coordinates, orientations or grids. For an integral over a surface, check which normal is defined. Read the value and unit fields exposed before passing them to other calculations.
Function index
magnetics.bh.coercivitymagnetics.bh.cycle_alignmagnetics.bh.differential_permeabilitymagnetics.bh.incremental_permeabilitymagnetics.bh.interpolatemagnetics.bh.loop_areamagnetics.bh.remanencemagnetics.bh.saturation_indicatormagnetics.circuit.couplingmagnetics.circuit.energy_derived_inductancemagnetics.circuit.flux_linkagemagnetics.circuit.inductancemagnetics.circuit.inductance_matrixmagnetics.circuit.mmfmagnetics.circuit.mutual_inductancemagnetics.circuit.parallel_reluctancemagnetics.circuit.permeancemagnetics.circuit.reluctancemagnetics.circuit.series_reluctancemagnetics.constitutive.anisotropic_b_from_hmagnetics.constitutive.b_from_hmagnetics.constitutive.h_from_bmagnetics.constitutive.nonlinear_b_from_hmagnetics.constitutive.permeabilitymagnetics.constitutive.vacuum_permeabilitymagnetics.coordinates.cartesian_to_cylindricalmagnetics.coordinates.cartesian_to_sphericalmagnetics.coordinates.cylindrical_to_cartesianmagnetics.coordinates.spherical_to_cartesianmagnetics.energy.coenergy_curvemagnetics.energy.densitymagnetics.energy.electric_densitymagnetics.energy.energy_curvemagnetics.energy.force_from_gradientmagnetics.energy.integratedmagnetics.energy.torque_from_gradientmagnetics.field.crossmagnetics.field.curlmagnetics.field.divergencemagnetics.field.dotmagnetics.field.gradientmagnetics.field.joule_lossmagnetics.field.laplacianmagnetics.field.magnitudemagnetics.field.normal_componentmagnetics.field.phasormagnetics.field.samplemagnetics.field.time_average_powermagnetics.integral.circulationmagnetics.integral.fluxmagnetics.integral.linemagnetics.integral.mmfmagnetics.integral.powermagnetics.integral.surface_fluxmagnetics.integral.volumemagnetics.loss.arbitrary_waveformmagnetics.loss.steinmetz
magnetics.bh.coercivity
Coercive field.
- Signature
magnetics.bh.coercivity(H, B, unused, options)- Arguments
H B unused options- Technical descriptors
Show shapes and scopes by argument
{name H shape matching_real_vectors source cell,range,column,scalar,option} {name B shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_real_vectors- Unit rule
T;A_per_m;J_per_m3;H_per_m- Units
T;A_per_m;J_per_m3;H_per_m- Result fields
scalar_or_vector_metrics- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(-2,-1,0,1,2,1,0,-1,-2) , vector(-1,-0.55,0.15,0.65,1,0.55,-0.12,-0.7,-1). Press Preview fields. The results include values, unit.
magnetics.bh.cycle_align
Aligns B–H loops according to the indicated phase or coordinate convention.
- Signature
magnetics.bh.cycle_align(H, B, unused, options)- Arguments
H B unused options- Technical descriptors
Show shapes and scopes by argument
{name H shape matching_real_vectors source cell,range,column,scalar,option} {name B shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_real_vectors- Unit rule
T;A_per_m;J_per_m3;H_per_m- Units
T;A_per_m;J_per_m3;H_per_m- Result fields
scalar_or_vector_metrics- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(-2,-1,0,1,2,1,0,-1,-2) , vector(-1,-0.55,0.15,0.65,1,0.55,-0.12,-0.7,-1). Press Preview fields. The results include H, B, start_index.
magnetics.bh.differential_permeability
Estimates the local slope dB/dH of the curve.
- Signature
magnetics.bh.differential_permeability(H, B, unused, options)- Arguments
H B unused options- Technical descriptors
Show shapes and scopes by argument
{name H shape matching_real_vectors source cell,range,column,scalar,option} {name B shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_real_vectors- Unit rule
T;A_per_m;J_per_m3;H_per_m- Units
T;A_per_m;J_per_m3;H_per_m- Result fields
scalar_or_vector_metrics- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(-2,-1,0,1,2,1,0,-1,-2) , vector(-1,-0.55,0.15,0.65,1,0.55,-0.12,-0.7,-1). Press Preview fields. The results include value, unit.
magnetics.bh.incremental_permeability
Estimates the ratio between increments of B and H around the indicated bias.
- Signature
magnetics.bh.incremental_permeability(H, B, unused, options)- Arguments
H B unused options- Technical descriptors
Show shapes and scopes by argument
{name H shape matching_real_vectors source cell,range,column,scalar,option} {name B shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_real_vectors- Unit rule
T;A_per_m;J_per_m3;H_per_m- Units
T;A_per_m;J_per_m3;H_per_m- Result fields
scalar_or_vector_metrics- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(-4,-2,0,2,4) , vector(-0.4,-0.2,0,0.2,0.4). In Options use bias_h=0 delta_h=1. Press Preview fields. The results include value, unit.
magnetics.bh.interpolate
Interpolated evaluation at the requested points.
- Signature
magnetics.bh.interpolate(H, B, unused, options)- Arguments
H B unused options- Technical descriptors
Show shapes and scopes by argument
{name H shape matching_real_vectors source cell,range,column,scalar,option} {name B shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_real_vectors- Unit rule
T;A_per_m;J_per_m3;H_per_m- Units
T;A_per_m;J_per_m3;H_per_m- Result fields
scalar_or_vector_metrics- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(-4,-2,0,2,4), vector(-0.4,-0.2,0,0.2,0.4), vector(-1,1). In Options use method="linear". Press Preview fields. The results include B, unit.
magnetics.bh.loop_area
Area of the B–H loop.
- Signature
magnetics.bh.loop_area(H, B, unused, options)- Arguments
H B unused options- Technical descriptors
Show shapes and scopes by argument
{name H shape matching_real_vectors source cell,range,column,scalar,option} {name B shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_real_vectors- Unit rule
T;A_per_m;J_per_m3;H_per_m- Units
T;A_per_m;J_per_m3;H_per_m- Result fields
scalar_or_vector_metrics- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(-2,-1,0,1,2,1,0,-1,-2) , vector(-1,-0.55,0.15,0.65,1,0.55,-0.12,-0.7,-1). Press Preview fields. The results include area, unit.
magnetics.bh.remanence
Remanent field according to the B–H contract.
- Signature
magnetics.bh.remanence(H, B, unused, options)- Arguments
H B unused options- Technical descriptors
Show shapes and scopes by argument
{name H shape matching_real_vectors source cell,range,column,scalar,option} {name B shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_real_vectors- Unit rule
T;A_per_m;J_per_m3;H_per_m- Units
T;A_per_m;J_per_m3;H_per_m- Result fields
scalar_or_vector_metrics- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(-2,-1,0,1,2,1,0,-1,-2) , vector(-1,-0.55,0.15,0.65,1,0.55,-0.12,-0.7,-1). Press Preview fields. The results include values, unit.
magnetics.bh.saturation_indicator
Derives the saturation indicator using the provider criteria.
- Signature
magnetics.bh.saturation_indicator(H, B, unused, options)- Arguments
H B unused options- Technical descriptors
Show shapes and scopes by argument
{name H shape matching_real_vectors source cell,range,column,scalar,option} {name B shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_real_vectors- Unit rule
T;A_per_m;J_per_m3;H_per_m- Units
T;A_per_m;J_per_m3;H_per_m- Result fields
scalar_or_vector_metrics- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(-2,-1,0,1,2,1,0,-1,-2) , vector(-1,-0.55,0.15,0.65,1,0.55,-0.12,-0.7,-1). Press Preview fields. The results include maximum_abs_B, maximum_abs_H, unit_B, unit_H.
magnetics.circuit.coupling
Computes the coupling coefficient from positive mutual and self-inductances. The physically admissible magnitude is at most one.
- Signature
magnetics.circuit.coupling(quantity_a, quantity_b, quantity_c, options)- Arguments
quantity_a quantity_b quantity_c options- Technical descriptors
Show shapes and scopes by argument
{name quantity_a shape scalar_vector_or_two_coil_matrix source cell,range,column,scalar,option} {name quantity_b shape action-specific source cell,range,column,scalar,option} {name quantity_c shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_two_coil_matrix- Unit rule
A_per_Wb;Wb_per_A;A_turn;H- Units
A_per_Wb;Wb_per_A;A_turn;H- Result fields
scalar_or_matrix- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, 1, 2, 3. Press Preview fields. The results include value_real, value_imaginary.
magnetics.circuit.energy_derived_inductance
Derives the inductance from magnetic energy and current according to the declared model.
- Signature
magnetics.circuit.energy_derived_inductance(quantity_a, quantity_b, quantity_c, options)- Arguments
quantity_a quantity_b quantity_c options- Technical descriptors
Show shapes and scopes by argument
{name quantity_a shape scalar_vector_or_two_coil_matrix source cell,range,column,scalar,option} {name quantity_b shape action-specific source cell,range,column,scalar,option} {name quantity_c shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_two_coil_matrix- Unit rule
A_per_Wb;Wb_per_A;A_turn;H- Units
A_per_Wb;Wb_per_A;A_turn;H- Result fields
scalar_or_matrix- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, 5, 2, 3. Press Preview fields. The results include value_real, value_imaginary, unit.
magnetics.circuit.flux_linkage
Flux linkage.
- Signature
magnetics.circuit.flux_linkage(quantity_a, quantity_b, quantity_c, options)- Arguments
quantity_a quantity_b quantity_c options- Technical descriptors
Show shapes and scopes by argument
{name quantity_a shape scalar_vector_or_two_coil_matrix source cell,range,column,scalar,option} {name quantity_b shape action-specific source cell,range,column,scalar,option} {name quantity_c shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_two_coil_matrix- Unit rule
A_per_Wb;Wb_per_A;A_turn;H- Units
A_per_Wb;Wb_per_A;A_turn;H- Result fields
scalar_or_matrix- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, 5, 2, 3. Press Preview fields. The results include value_real, value_imaginary, unit.
magnetics.circuit.inductance
Computes the inductance from the ratio of flux linkage to current.
- Signature
magnetics.circuit.inductance(quantity_a, quantity_b, quantity_c, options)- Arguments
quantity_a quantity_b quantity_c options- Technical descriptors
Show shapes and scopes by argument
{name quantity_a shape scalar_vector_or_two_coil_matrix source cell,range,column,scalar,option} {name quantity_b shape action-specific source cell,range,column,scalar,option} {name quantity_c shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_two_coil_matrix- Unit rule
A_per_Wb;Wb_per_A;A_turn;H- Units
A_per_Wb;Wb_per_A;A_turn;H- Result fields
scalar_or_matrix- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, 5, 2, 3. Press Preview fields. The results include value_real, value_imaginary, unit.
magnetics.circuit.inductance_matrix
Builds the matrix of the two self-inductances and the physically compatible mutual inductance.
- Signature
magnetics.circuit.inductance_matrix(quantity_a, quantity_b, quantity_c, options)- Arguments
quantity_a quantity_b quantity_c options- Technical descriptors
Show shapes and scopes by argument
{name quantity_a shape scalar_vector_or_two_coil_matrix source cell,range,column,scalar,option} {name quantity_b shape action-specific source cell,range,column,scalar,option} {name quantity_c shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_two_coil_matrix- Unit rule
A_per_Wb;Wb_per_A;A_turn;H- Units
A_per_Wb;Wb_per_A;A_turn;H- Result fields
scalar_or_matrix- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(2,3) , 1. Press Preview fields. The results include value_real, value_imaginary, unit.
magnetics.circuit.mmf
Magnetomotive force.
- Signature
magnetics.circuit.mmf(quantity_a, quantity_b, quantity_c, options)- Arguments
quantity_a quantity_b quantity_c options- Technical descriptors
Show shapes and scopes by argument
{name quantity_a shape scalar_vector_or_two_coil_matrix source cell,range,column,scalar,option} {name quantity_b shape action-specific source cell,range,column,scalar,option} {name quantity_c shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_two_coil_matrix- Unit rule
A_per_Wb;Wb_per_A;A_turn;H- Units
A_per_Wb;Wb_per_A;A_turn;H- Result fields
scalar_or_matrix- Provider
math.magnetics · MAGNETICS_API_v1
Example of guided operation. quantity_a = 5 and quantity_b = 2. The value_real field gives 10.
magnetics.circuit.mutual_inductance
Derives the mutual inductance from flux, turns and source current.
- Signature
magnetics.circuit.mutual_inductance(quantity_a, quantity_b, quantity_c, options)- Arguments
quantity_a quantity_b quantity_c options- Technical descriptors
Show shapes and scopes by argument
{name quantity_a shape scalar_vector_or_two_coil_matrix source cell,range,column,scalar,option} {name quantity_b shape action-specific source cell,range,column,scalar,option} {name quantity_c shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_two_coil_matrix- Unit rule
A_per_Wb;Wb_per_A;A_turn;H- Units
A_per_Wb;Wb_per_A;A_turn;H- Result fields
scalar_or_matrix- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, 5, 2, 3. Press Preview fields. The results include value_real, value_imaginary, unit.
magnetics.circuit.parallel_reluctance
Combines the equivalent reluctances of parallel branches.
- Signature
magnetics.circuit.parallel_reluctance(quantity_a, quantity_b, quantity_c, options)- Arguments
quantity_a quantity_b quantity_c options- Technical descriptors
Show shapes and scopes by argument
{name quantity_a shape scalar_vector_or_two_coil_matrix source cell,range,column,scalar,option} {name quantity_b shape action-specific source cell,range,column,scalar,option} {name quantity_c shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_two_coil_matrix- Unit rule
A_per_Wb;Wb_per_A;A_turn;H- Units
A_per_Wb;Wb_per_A;A_turn;H- Result fields
scalar_or_matrix- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, 5, 2, 3. Press Preview fields. The results include value_real, value_imaginary, unit.
magnetics.circuit.permeance
Permeance.
- Signature
magnetics.circuit.permeance(quantity_a, quantity_b, quantity_c, options)- Arguments
quantity_a quantity_b quantity_c options- Technical descriptors
Show shapes and scopes by argument
{name quantity_a shape scalar_vector_or_two_coil_matrix source cell,range,column,scalar,option} {name quantity_b shape action-specific source cell,range,column,scalar,option} {name quantity_c shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_two_coil_matrix- Unit rule
A_per_Wb;Wb_per_A;A_turn;H- Units
A_per_Wb;Wb_per_A;A_turn;H- Result fields
scalar_or_matrix- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, 5, 2, 3. Press Preview fields. The results include value_real, value_imaginary, unit.
magnetics.circuit.reluctance
Reluctance.
- Signature
magnetics.circuit.reluctance(quantity_a, quantity_b, quantity_c, options)- Arguments
quantity_a quantity_b quantity_c options- Technical descriptors
Show shapes and scopes by argument
{name quantity_a shape scalar_vector_or_two_coil_matrix source cell,range,column,scalar,option} {name quantity_b shape action-specific source cell,range,column,scalar,option} {name quantity_c shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_two_coil_matrix- Unit rule
A_per_Wb;Wb_per_A;A_turn;H- Units
A_per_Wb;Wb_per_A;A_turn;H- Result fields
scalar_or_matrix- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, 5, 2, 3. Press Preview fields. The results include value_real, value_imaginary, unit.
magnetics.circuit.series_reluctance
Sums the reluctances of segments in series.
- Signature
magnetics.circuit.series_reluctance(quantity_a, quantity_b, quantity_c, options)- Arguments
quantity_a quantity_b quantity_c options- Technical descriptors
Show shapes and scopes by argument
{name quantity_a shape scalar_vector_or_two_coil_matrix source cell,range,column,scalar,option} {name quantity_b shape action-specific source cell,range,column,scalar,option} {name quantity_c shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_two_coil_matrix- Unit rule
A_per_Wb;Wb_per_A;A_turn;H- Units
A_per_Wb;Wb_per_A;A_turn;H- Result fields
scalar_or_matrix- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, 5, 2, 3. Press Preview fields. The results include value_real, value_imaginary, unit.
magnetics.constitutive.anisotropic_b_from_h
Computes the flux density from H by applying the anisotropic constitutive law.
- Signature
magnetics.constitutive.anisotropic_b_from_h(field, relative_permeability, unused, options)- Arguments
field relative_permeability unused options- Technical descriptors
Show shapes and scopes by argument
{name field shape scalar_vector_or_field source cell,range,column,scalar,option} {name relative_permeability shape scalar_or_field source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_field;scalar_or_field- Unit rule
T;A_per_m;H_per_m- Units
T;A_per_m;H_per_m- Result fields
same_shape- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(3,4,0,0,0,5),2,3) , matrix(vector(2,0,0,0,3,0,0,0,4),3,3). Press Preview fields. The results include value_real, value_imaginary, permeability_unit.
magnetics.constitutive.b_from_h
Computes B from H and the given permeability.
- Signature
magnetics.constitutive.b_from_h(field, relative_permeability, unused, options)- Arguments
field relative_permeability unused options- Technical descriptors
Show shapes and scopes by argument
{name field shape scalar_vector_or_field source cell,range,column,scalar,option} {name relative_permeability shape scalar_or_field source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_field;scalar_or_field- Unit rule
T;A_per_m;H_per_m- Units
T;A_per_m;H_per_m- Result fields
same_shape- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(0,0,1,0,0,1,1,1),4,2) , 2. Press Preview fields. The results include value_real, value_imaginary, permeability_unit.
magnetics.constitutive.h_from_b
Computes H from B and the given permeability.
- Signature
magnetics.constitutive.h_from_b(field, relative_permeability, unused, options)- Arguments
field relative_permeability unused options- Technical descriptors
Show shapes and scopes by argument
{name field shape scalar_vector_or_field source cell,range,column,scalar,option} {name relative_permeability shape scalar_or_field source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_field;scalar_or_field- Unit rule
T;A_per_m;H_per_m- Units
T;A_per_m;H_per_m- Result fields
same_shape- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(0,0,1,0,0,1,1,1),4,2) , 2. Press Preview fields. The results include value_real, value_imaginary, permeability_unit.
magnetics.constitutive.nonlinear_b_from_h
Derives B from H using the nonlinear constitutive curve.
- Signature
magnetics.constitutive.nonlinear_b_from_h(field, relative_permeability, unused, options)- Arguments
field relative_permeability unused options- Technical descriptors
Show shapes and scopes by argument
{name field shape scalar_vector_or_field source cell,range,column,scalar,option} {name relative_permeability shape scalar_or_field source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_field;scalar_or_field- Unit rule
T;A_per_m;H_per_m- Units
T;A_per_m;H_per_m- Result fields
same_shape- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(-1,1), vector(-4,-2,0,2,4), vector(-0.4,-0.2,0,0.2,0.4). In Options use method="linear". Press Preview fields. The results include value_real, value_imaginary.
magnetics.constitutive.permeability
Returns the permeability according to the selected constitutive model.
- Signature
magnetics.constitutive.permeability(field, relative_permeability, unused, options)- Arguments
field relative_permeability unused options- Technical descriptors
Show shapes and scopes by argument
{name field shape scalar_vector_or_field source cell,range,column,scalar,option} {name relative_permeability shape scalar_or_field source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_field;scalar_or_field- Unit rule
T;A_per_m;H_per_m- Units
T;A_per_m;H_per_m- Result fields
same_shape- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(0,0,1,0,0,1,1,1),4,2) , 2. Press Preview fields. The results include value_real, value_imaginary, permeability_unit.
magnetics.constitutive.vacuum_permeability
Vacuum permeability.
- Signature
magnetics.constitutive.vacuum_permeability(field, relative_permeability, unused, options)- Arguments
field relative_permeability unused options- Technical descriptors
Show shapes and scopes by argument
{name field shape scalar_vector_or_field source cell,range,column,scalar,option} {name relative_permeability shape scalar_or_field source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalar_vector_or_field;scalar_or_field- Unit rule
T;A_per_m;H_per_m- Units
T;A_per_m;H_per_m- Result fields
same_shape- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. The test leaves the optional operands empty. Press Preview fields. The results include value, unit.
magnetics.coordinates.cartesian_to_cylindrical
Converts Cartesian points to cylindrical coordinates.
- Signature
magnetics.coordinates.cartesian_to_cylindrical(points, components, unused, options)- Arguments
points components unused options- Technical descriptors
Show shapes and scopes by argument
{name points shape N_by_3 source cell,range,column,scalar,option} {name components shape optional_N_by_3 source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
N_by_3;optional_N_by_3- Unit rule
caller_coordinate_units;radians- Units
caller_coordinate_units;radians- Result fields
N_by_3- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(1,0,0,0,1,0,0,0,1,1,2,3),4,3) . Press Preview fields. The results include value_real, value_imaginary.
magnetics.coordinates.cartesian_to_spherical
Converts Cartesian points to spherical coordinates.
- Signature
magnetics.coordinates.cartesian_to_spherical(points, components, unused, options)- Arguments
points components unused options- Technical descriptors
Show shapes and scopes by argument
{name points shape N_by_3 source cell,range,column,scalar,option} {name components shape optional_N_by_3 source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
N_by_3;optional_N_by_3- Unit rule
caller_coordinate_units;radians- Units
caller_coordinate_units;radians- Result fields
N_by_3- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(1,0,0,0,1,0,0,0,1,1,2,3),4,3) . Press Preview fields. The results include value_real, value_imaginary.
magnetics.coordinates.cylindrical_to_cartesian
Reconstructs the Cartesian coordinates from radius, angle and height.
- Signature
magnetics.coordinates.cylindrical_to_cartesian(points, components, unused, options)- Arguments
points components unused options- Technical descriptors
Show shapes and scopes by argument
{name points shape N_by_3 source cell,range,column,scalar,option} {name components shape optional_N_by_3 source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
N_by_3;optional_N_by_3- Unit rule
caller_coordinate_units;radians- Units
caller_coordinate_units;radians- Result fields
N_by_3- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(1,0,0,0,1,0,0,0,1,1,2,3),4,3) . Press Preview fields. The results include value_real, value_imaginary.
magnetics.coordinates.spherical_to_cartesian
Reconstructs the Cartesian coordinates from the spherical components in the indicated convention.
- Signature
magnetics.coordinates.spherical_to_cartesian(points, components, unused, options)- Arguments
points components unused options- Technical descriptors
Show shapes and scopes by argument
{name points shape N_by_3 source cell,range,column,scalar,option} {name components shape optional_N_by_3 source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
N_by_3;optional_N_by_3- Unit rule
caller_coordinate_units;radians- Units
caller_coordinate_units;radians- Result fields
N_by_3- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(1,0,0,0,1,0,0,0,1,1,2,3),4,3) . Press Preview fields. The results include value_real, value_imaginary.
magnetics.energy.coenergy_curve
Derives the co-energy from the sampled constitutive or circuit relation.
- Signature
magnetics.energy.coenergy_curve(B, H, geometry, options)- Arguments
B H geometry options- Technical descriptors
Show shapes and scopes by argument
{name B shape matching_fields source cell,range,column,scalar,option} {name H shape optional_regular_grid source cell,range,column,scalar,option} {name geometry shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_fields;optional_regular_grid- Unit rule
J_per_m3;J- Units
J_per_m3;J- Result fields
density_or_scalar- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(2,5,1), vector(1,2,3), vector(1,2,3,4,5,6,7,8). Press Preview fields. The results include coenergy_density, unit.
magnetics.energy.density
Computes the magnetic energy density according to the quantities and units of the model.
- Signature
magnetics.energy.density(B, H, geometry, options)- Arguments
B H geometry options- Technical descriptors
Show shapes and scopes by argument
{name B shape matching_fields source cell,range,column,scalar,option} {name H shape optional_regular_grid source cell,range,column,scalar,option} {name geometry shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_fields;optional_regular_grid- Unit rule
J_per_m3;J- Units
J_per_m3;J- Result fields
density_or_scalar- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(2,5,1), vector(1,2,3), vector(1,2,3,4,5,6,7,8). Press Preview fields. The results include energy_density, unit.
magnetics.energy.electric_density
Computes the electric energy density. Keep consistent units for field and permittivity.
- Signature
magnetics.energy.electric_density(B, H, geometry, options)- Arguments
B H geometry options- Technical descriptors
Show shapes and scopes by argument
{name B shape matching_fields source cell,range,column,scalar,option} {name H shape optional_regular_grid source cell,range,column,scalar,option} {name geometry shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_fields;optional_regular_grid- Unit rule
J_per_m3;J- Units
J_per_m3;J- Result fields
density_or_scalar- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(2,5,1), vector(1,2,3), vector(1,2,3,4,5,6,7,8). Press Preview fields. The results include energy_density, unit.
magnetics.energy.energy_curve
Derives the energy along the sampled constitutive or circuit curve.
- Signature
magnetics.energy.energy_curve(B, H, geometry, options)- Arguments
B H geometry options- Technical descriptors
Show shapes and scopes by argument
{name B shape matching_fields source cell,range,column,scalar,option} {name H shape optional_regular_grid source cell,range,column,scalar,option} {name geometry shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_fields;optional_regular_grid- Unit rule
J_per_m3;J- Units
J_per_m3;J- Result fields
density_or_scalar- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(2,5,1), vector(1,2,3), vector(1,2,3,4,5,6,7,8). Press Preview fields. The results include energy_density, unit.
magnetics.energy.force_from_gradient
Derives the force from the spatial gradient of the declared energy or co-energy.
- Signature
magnetics.energy.force_from_gradient(B, H, geometry, options)- Arguments
B H geometry options- Technical descriptors
Show shapes and scopes by argument
{name B shape matching_fields source cell,range,column,scalar,option} {name H shape optional_regular_grid source cell,range,column,scalar,option} {name geometry shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_fields;optional_regular_grid- Unit rule
J_per_m3;J- Units
J_per_m3;J- Result fields
density_or_scalar- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(2,5,1), vector(1,2,3), vector(1,2,3,4,5,6,7,8). Press Preview fields. The results include value_real, value_imaginary, unit.
magnetics.energy.integrated
Integrates the energy over the sampled domain and the declared coordinates.
- Signature
magnetics.energy.integrated(B, H, geometry, options)- Arguments
B H geometry options- Technical descriptors
Show shapes and scopes by argument
{name B shape matching_fields source cell,range,column,scalar,option} {name H shape optional_regular_grid source cell,range,column,scalar,option} {name geometry shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_fields;optional_regular_grid- Unit rule
J_per_m3;J- Units
J_per_m3;J- Result fields
density_or_scalar- Provider
math.magnetics · MAGNETICS_API_v1
In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.
Provide the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.
magnetics.energy.torque_from_gradient
Derives the torque from the variation with respect to the angular coordinate.
- Signature
magnetics.energy.torque_from_gradient(B, H, geometry, options)- Arguments
B H geometry options- Technical descriptors
Show shapes and scopes by argument
{name B shape matching_fields source cell,range,column,scalar,option} {name H shape optional_regular_grid source cell,range,column,scalar,option} {name geometry shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
matching_fields;optional_regular_grid- Unit rule
J_per_m3;J- Units
J_per_m3;J- Result fields
density_or_scalar- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(2,5,1), vector(1,2,3), vector(1,2,3,4,5,6,7,8). Press Preview fields. The results include value_real, value_imaginary, unit.
magnetics.field.cross
Cross product of triples.
- Signature
magnetics.field.cross(axes_or_first_field, field, query_or_normals, options)- Arguments
axes_or_first_field field query_or_normals options- Technical descriptors
Show shapes and scopes by argument
{name axes_or_first_field shape regular_axes_or_N_by_3_or_4D_vector source cell,range,column,scalar,option} {name field shape action-specific source cell,range,column,scalar,option} {name query_or_normals shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
regular_axes_or_N_by_3_or_4D_vector- Unit rule
caller_field_unit;W_per_m2_for_power- Units
caller_field_unit;W_per_m2_for_power- Result fields
samples scalar_or_vector_field- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(1,0,0,0,1,0,0,0,1,1,2,3),4,3) , matrix(vector(1,0,0,2,0,0,1,1,0,1,0,1),4,3). Press Preview fields. The results include value_real, value_imaginary.
magnetics.field.curl
Computes the curl of the vector field on a grid.
- Signature
magnetics.field.curl(axes_or_first_field, field, query_or_normals, options)- Arguments
axes_or_first_field field query_or_normals options- Technical descriptors
Show shapes and scopes by argument
{name axes_or_first_field shape regular_axes_or_N_by_3_or_4D_vector source cell,range,column,scalar,option} {name field shape action-specific source cell,range,column,scalar,option} {name query_or_normals shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
regular_axes_or_N_by_3_or_4D_vector- Unit rule
caller_field_unit;W_per_m2_for_power- Units
caller_field_unit;W_per_m2_for_power- Result fields
samples scalar_or_vector_field- Provider
math.magnetics · MAGNETICS_API_v1
In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.
Provide the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.
magnetics.field.divergence
Computes the divergence as the sum of the derivatives along the field axes.
- Signature
magnetics.field.divergence(axes_or_first_field, field, query_or_normals, options)- Arguments
axes_or_first_field field query_or_normals options- Technical descriptors
Show shapes and scopes by argument
{name axes_or_first_field shape regular_axes_or_N_by_3_or_4D_vector source cell,range,column,scalar,option} {name field shape action-specific source cell,range,column,scalar,option} {name query_or_normals shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
regular_axes_or_N_by_3_or_4D_vector- Unit rule
caller_field_unit;W_per_m2_for_power- Units
caller_field_unit;W_per_m2_for_power- Result fields
samples scalar_or_vector_field- Provider
math.magnetics · MAGNETICS_API_v1
In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.
Provide the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.
magnetics.field.dot
Dot product.
- Signature
magnetics.field.dot(axes_or_first_field, field, query_or_normals, options)- Arguments
axes_or_first_field field query_or_normals options- Technical descriptors
Show shapes and scopes by argument
{name axes_or_first_field shape regular_axes_or_N_by_3_or_4D_vector source cell,range,column,scalar,option} {name field shape action-specific source cell,range,column,scalar,option} {name query_or_normals shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
regular_axes_or_N_by_3_or_4D_vector- Unit rule
caller_field_unit;W_per_m2_for_power- Units
caller_field_unit;W_per_m2_for_power- Result fields
samples scalar_or_vector_field- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(1,0,0,0,1,0),2,3) , matrix(vector(5,0,0,0,4,0),2,3). Press Preview fields. The results include value_real, value_imaginary.
magnetics.field.gradient
Estimates the direction and rate of change of the field with respect to the coordinates.
- Signature
magnetics.field.gradient(axes_or_first_field, field, query_or_normals, options)- Arguments
axes_or_first_field field query_or_normals options- Technical descriptors
Show shapes and scopes by argument
{name axes_or_first_field shape regular_axes_or_N_by_3_or_4D_vector source cell,range,column,scalar,option} {name field shape action-specific source cell,range,column,scalar,option} {name query_or_normals shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
regular_axes_or_N_by_3_or_4D_vector- Unit rule
caller_field_unit;W_per_m2_for_power- Units
caller_field_unit;W_per_m2_for_power- Result fields
samples scalar_or_vector_field- Provider
math.magnetics · MAGNETICS_API_v1
In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.
Provide the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.
magnetics.field.joule_loss
Computes the Joule loss from the relation between electric field and conduction.
- Signature
magnetics.field.joule_loss(axes_or_first_field, field, query_or_normals, options)- Arguments
axes_or_first_field field query_or_normals options- Technical descriptors
Show shapes and scopes by argument
{name axes_or_first_field shape regular_axes_or_N_by_3_or_4D_vector source cell,range,column,scalar,option} {name field shape action-specific source cell,range,column,scalar,option} {name query_or_normals shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
regular_axes_or_N_by_3_or_4D_vector- Unit rule
caller_field_unit;W_per_m2_for_power- Units
caller_field_unit;W_per_m2_for_power- Result fields
samples scalar_or_vector_field- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(3,4,0,0,0,5),2,3) , matrix(vector(1,0,0,0,0,1),2,3). In Options use phasor=1. Press Preview fields. The results include loss_density, unit.
magnetics.field.laplacian
Computes the Laplacian through second derivatives over the grid coordinates.
- Signature
magnetics.field.laplacian(axes_or_first_field, field, query_or_normals, options)- Arguments
axes_or_first_field field query_or_normals options- Technical descriptors
Show shapes and scopes by argument
{name axes_or_first_field shape regular_axes_or_N_by_3_or_4D_vector source cell,range,column,scalar,option} {name field shape action-specific source cell,range,column,scalar,option} {name query_or_normals shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
regular_axes_or_N_by_3_or_4D_vector- Unit rule
caller_field_unit;W_per_m2_for_power- Units
caller_field_unit;W_per_m2_for_power- Result fields
samples scalar_or_vector_field- Provider
math.magnetics · MAGNETICS_API_v1
In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.
Provide the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.
magnetics.field.magnitude
Computes the magnitude, per sample or per vector according to the indicated form.
- Signature
magnetics.field.magnitude(axes_or_first_field, field, query_or_normals, options)- Arguments
axes_or_first_field field query_or_normals options- Technical descriptors
Show shapes and scopes by argument
{name axes_or_first_field shape regular_axes_or_N_by_3_or_4D_vector source cell,range,column,scalar,option} {name field shape action-specific source cell,range,column,scalar,option} {name query_or_normals shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
regular_axes_or_N_by_3_or_4D_vector- Unit rule
caller_field_unit;W_per_m2_for_power- Units
caller_field_unit;W_per_m2_for_power- Result fields
samples scalar_or_vector_field- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, empty() , matrix(vector(3,4,0,0,0,5),2,3). Press Preview fields. The results include magnitude.
magnetics.field.normal_component
Projects the field on the declared normal.
- Signature
magnetics.field.normal_component(axes_or_first_field, field, query_or_normals, options)- Arguments
axes_or_first_field field query_or_normals options- Technical descriptors
Show shapes and scopes by argument
{name axes_or_first_field shape regular_axes_or_N_by_3_or_4D_vector source cell,range,column,scalar,option} {name field shape action-specific source cell,range,column,scalar,option} {name query_or_normals shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
regular_axes_or_N_by_3_or_4D_vector- Unit rule
caller_field_unit;W_per_m2_for_power- Units
caller_field_unit;W_per_m2_for_power- Result fields
samples scalar_or_vector_field- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, empty(), matrix(vector(3,4,0,0,0,5),2,3), matrix(vector(1,0,0,0,0,1),2,3). Press Preview fields. The results include value_real, value_imaginary, tangential_real, tangential_imaginary.
magnetics.field.phasor
Represents the field through phasor components and the associated information.
- Signature
magnetics.field.phasor(axes_or_first_field, field, query_or_normals, options)- Arguments
axes_or_first_field field query_or_normals options- Technical descriptors
Show shapes and scopes by argument
{name axes_or_first_field shape regular_axes_or_N_by_3_or_4D_vector source cell,range,column,scalar,option} {name field shape action-specific source cell,range,column,scalar,option} {name query_or_normals shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
regular_axes_or_N_by_3_or_4D_vector- Unit rule
caller_field_unit;W_per_m2_for_power- Units
caller_field_unit;W_per_m2_for_power- Result fields
samples scalar_or_vector_field- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, empty() , complex(matrix(vector(3,4,0,0,0,5),2,3),matrix(vector(1,0,0,0,0,1),2,3)). Press Preview fields. The results include magnitude, phase_rad, real, imaginary, conjugate_real, conjugate_imaginary.
magnetics.field.sample
Samples a field at the indicated points on the grid or in the provider geometry.
- Signature
magnetics.field.sample(axes_or_first_field, field, query_or_normals, options)- Arguments
axes_or_first_field field query_or_normals options- Technical descriptors
Show shapes and scopes by argument
{name axes_or_first_field shape regular_axes_or_N_by_3_or_4D_vector source cell,range,column,scalar,option} {name field shape action-specific source cell,range,column,scalar,option} {name query_or_normals shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
regular_axes_or_N_by_3_or_4D_vector- Unit rule
caller_field_unit;W_per_m2_for_power- Units
caller_field_unit;W_per_m2_for_power- Result fields
samples scalar_or_vector_field- Provider
math.magnetics · MAGNETICS_API_v1
In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.
Provide the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.
magnetics.field.time_average_power
Computes the time-averaged power according to the phasors and the provider normalization.
- Signature
magnetics.field.time_average_power(axes_or_first_field, field, query_or_normals, options)- Arguments
axes_or_first_field field query_or_normals options- Technical descriptors
Show shapes and scopes by argument
{name axes_or_first_field shape regular_axes_or_N_by_3_or_4D_vector source cell,range,column,scalar,option} {name field shape action-specific source cell,range,column,scalar,option} {name query_or_normals shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
regular_axes_or_N_by_3_or_4D_vector- Unit rule
caller_field_unit;W_per_m2_for_power- Units
caller_field_unit;W_per_m2_for_power- Result fields
samples scalar_or_vector_field- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(1,0,0,0,1,0,0,0,1,1,2,3),4,3) , matrix(vector(1,0,0,2,0,0,1,1,0,1,0,1),4,3). Press Preview fields. The results include value_real, value_imaginary, active_power_density, reactive_power_density, unit.
magnetics.integral.circulation
Integrates the tangential component of the field along the oriented trajectory.
- Signature
magnetics.integral.circulation(geometry, field, connectivity, options)- Arguments
geometry field connectivity options- Technical descriptors
Show shapes and scopes by argument
{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}- Input shape
path_or_vertices_or_grid;field;triangles- Unit rule
field_unit_times_length_area_or_volume- Units
field_unit_times_length_area_or_volume- Result fields
scalar- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3) , matrix(vector(1,0,0,0,1,0,0,0,1,1,2,3),4,3). Press Preview fields. The results include value_real, value_imaginary.
magnetics.integral.flux
Integrates the normal field through the faces of the surface.
- Signature
magnetics.integral.flux(geometry, field, connectivity, options)- Arguments
geometry field connectivity options- Technical descriptors
Show shapes and scopes by argument
{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}- Input shape
path_or_vertices_or_grid;field;triangles- Unit rule
field_unit_times_length_area_or_volume- Units
field_unit_times_length_area_or_volume- Result fields
scalar- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3), matrix(vector(1,0,0,0,1,0,0,0,1,1,2,3),4,3), matrix(vector(1,3,2,1,2,4,1,4,3,2,3,4),4,3). Press Preview fields. The results include value_real, value_imaginary.
magnetics.integral.line
Computes the line integral along ordered points, checking the direction of the path.
- Signature
magnetics.integral.line(geometry, field, connectivity, options)- Arguments
geometry field connectivity options- Technical descriptors
Show shapes and scopes by argument
{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}- Input shape
path_or_vertices_or_grid;field;triangles- Unit rule
field_unit_times_length_area_or_volume- Units
field_unit_times_length_area_or_volume- Result fields
scalar- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0),3,3) , matrix(vector(1,0,0,1,0,0,1,0,0),3,3). Press Preview fields. The results include value_real, value_imaginary.
magnetics.integral.mmf
Magnetomotive force.
- Signature
magnetics.integral.mmf(geometry, field, connectivity, options)- Arguments
geometry field connectivity options- Technical descriptors
Show shapes and scopes by argument
{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}- Input shape
path_or_vertices_or_grid;field;triangles- Unit rule
field_unit_times_length_area_or_volume- Units
field_unit_times_length_area_or_volume- Result fields
scalar- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3) , matrix(vector(1,0,0,0,1,0,0,0,1,1,2,3),4,3). Press Preview fields. The results include value_real, value_imaginary.
magnetics.integral.power
Power with base and exponent.
- Signature
magnetics.integral.power(geometry, field, connectivity, options)- Arguments
geometry field connectivity options- Technical descriptors
Show shapes and scopes by argument
{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}- Input shape
path_or_vertices_or_grid;field;triangles- Unit rule
field_unit_times_length_area_or_volume- Units
field_unit_times_length_area_or_volume- Result fields
scalar- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0),3,3), matrix(vector(0,0,4),1,3), matrix(vector(1,2,3),1,3). Press Preview fields. The results include value_real, value_imaginary, unit.
magnetics.integral.surface_flux
Integrates the normal component over the surface. The orientation of the faces determines the sign.
- Signature
magnetics.integral.surface_flux(geometry, field, connectivity, options)- Arguments
geometry field connectivity options- Technical descriptors
Show shapes and scopes by argument
{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}- Input shape
path_or_vertices_or_grid;field;triangles- Unit rule
field_unit_times_length_area_or_volume- Units
field_unit_times_length_area_or_volume- Result fields
scalar- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0),3,3), matrix(vector(0,0,4),1,3), matrix(vector(1,2,3),1,3). Press Preview fields. The results include value_real, value_imaginary.
magnetics.integral.volume
Integrates the sampled values over a volume along the three declared axes.
- Signature
magnetics.integral.volume(geometry, field, connectivity, options)- Arguments
geometry field connectivity options- Technical descriptors
Show shapes and scopes by argument
{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}- Input shape
path_or_vertices_or_grid;field;triangles- Unit rule
field_unit_times_length_area_or_volume- Units
field_unit_times_length_area_or_volume- Result fields
scalar- Provider
math.magnetics · MAGNETICS_API_v1
In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.
Provide the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.
magnetics.loss.arbitrary_waveform
Estimates magnetic losses from a flux-density waveform and increasing times.
- Signature
magnetics.loss.arbitrary_waveform(B_peak_or_time, frequency_or_B_waveform, unused, options)- Arguments
B_peak_or_time frequency_or_B_waveform unused options- Technical descriptors
Show shapes and scopes by argument
{name B_peak_or_time shape scalars_or_matching_vectors source cell,range,column,scalar,option} {name frequency_or_B_waveform shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalars_or_matching_vectors- Unit rule
W_per_m3- Units
W_per_m3- Result fields
loss_density- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1) , vector(0,0.2,0,-0.2,0). In Options use ki=2 alpha=1.5 beta=2. Press Preview fields. The results include loss_density, unit, method.
magnetics.loss.steinmetz
Estimates magnetic losses using the coefficients of the Steinmetz equation.
- Signature
magnetics.loss.steinmetz(B_peak_or_time, frequency_or_B_waveform, unused, options)- Arguments
B_peak_or_time frequency_or_B_waveform unused options- Technical descriptors
Show shapes and scopes by argument
{name B_peak_or_time shape scalars_or_matching_vectors source cell,range,column,scalar,option} {name frequency_or_B_waveform shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}- Input shape
scalars_or_matching_vectors- Unit rule
W_per_m3- Units
W_per_m3- Result fields
loss_density- Provider
math.magnetics · MAGNETICS_API_v1
Example with synthetic data. Enter, in order, 0.2 , 100. In Options use k=2 alpha=1.5 beta=2. Press Preview fields. The results include loss_density, unit, method.