ElectromagneticBCAssignment Properties

(To be removed) Electromagnetic boundary condition assignments

Since R2021a

ElectromagneticBCAssignment will be removed. Use the FaceBC and EdgeBC properties property of femodel instead. (since R2023a) For more information on updating your code, see Version History.

An ElectromagneticBCAssignment object specifies the type of PDE boundary condition on a set of geometry boundaries. An ElectromagneticModel object contains an array of ElectromagneticBCAssignment objects in its BoundaryConditions.BCAssignments property.

Create boundary condition assignments for your electromagnetic model using the electromagneticBC function.

Properties

ElectricField — Electric field boundary condition

column vector | function handle

Electric field boundary condition, specified as a column vector of two elements for a 2-D model, a column vector of three elements for a 3-D model, or a function handle. Use a function handle to specify an electric field that depends on the coordinates.

The solver uses an electric field boundary condition for a harmonic analysis with the electric field type.

Data Types: double | function_handle

MagneticField — Magnetic field boundary condition

column vector | function handle

Magnetic field boundary condition, specified as a column vector of two elements for a 2-D model, a column vector of three elements for a 3-D model, or a function handle. Use a function handle to specify a magnetic field that depends on the coordinates.

The solver uses a magnetic field boundary condition for a harmonic analysis with the magnetic field type.

Data Types: double | function_handle

MagneticPotential — Magnetic potential boundary condition

real number | column vector | function handle

Magnetic potential boundary condition, specified as a real number for a 2-D model, a column vector of three elements for a 3-D model, or a function handle. Use a function handle to specify a magnetic potential that depends on the coordinates.

The solver uses a magnetic potential boundary condition for a magnetostatic analysis.

Data Types: double | function_handle

SurfaceCurrentDensity — Surface current density boundary condition

real number

Surface current density boundary condition, specified as a real number. The solver uses a surface current density boundary condition for a DC conduction analysis.

Data Types: double

RegionID — Region ID

vector of positive integers

Region ID, specified as a vector of positive integers. Find the edge or face IDs by using pdegplot with the EdgeLabels or FaceLabels name-value argument set to "on".

Data Types: double

RegionType — Geometric region type

"Edge" for a 2-D model | "Face" for a 3-D model

Geometric region type, specified as "Edge" for a 2-D model or "Face" for a 3-D model.

Data Types: char | string

Vectorized — Vectorized function evaluation

"off" (default) | "on"

Vectorized function evaluation, specified as "off" or "on". This property applies when you pass a function handle as an argument. To save time in the function handle evaluation, specify "on" if your function handle computes in a vectorized fashion. See Vectorization. For details on vectorized function evaluation, see Nonconstant Boundary Conditions.

Data Types: char | string

Voltage — Voltage boundary condition

real number | function handle

Voltage boundary condition, specified as a real number or a function handle. Use a function handle to specify a voltage that depends on the coordinates.

The solver uses a voltage boundary condition for an electrostatic analysis.

Data Types: double | function_handle

FarField — Absorbing boundary condition

"absorbing"

Absorbing boundary condition, specified as "absorbing". The solver uses an absorbing boundary condition for a harmonic analysis.

Data Types: char

Thickness — Width of far field absorbing region

nonnegative number

Width of the far field absorbing region, specified as a nonnegative number. The solver uses an absorbing boundary condition for a harmonic analysis.

Data Types: double

Scaling — Scaling parameter defining attenuation rate

5 (default) | nonnegative number

Scaling parameter defining the attenuation rate of the waves entering the absorbing region, specified as a nonnegative number. The solver uses an absorbing boundary condition for a harmonic analysis.

Data Types: double

Exponent — Exponent defining attenuation rate

4 (default) | nonnegative number

Exponent defining the attenuation rate of the waves entering the absorbing region, specified as a nonnegative number. The solver uses an absorbing boundary condition for a harmonic analysis.

Data Types: double

Version History

Introduced in R2021a

R2025a: To be removed

ElectromagneticBCAssignment will be removed. Use the FaceBC and EdgeBC properties of femodel instead.

For example, you can check the boundary conditions for particular edges as follows.

model = femodel(AnalysisType="magnetostatic", ...
                Geometry=@lshapeg);
model.EdgeBC(1) = edgeBC(MagneticPotential=1);
model.EdgeBC(2) = edgeBC(MagneticPotential=0);
model.EdgeBC

The unified finite element model workflow defines the type of a problem and all of its parameters as the properties of an femodel object. This object enables you to specify physical parameters for structural, thermal, and electromagnetic types of analyses. The solver in the unified workflow uses only the parameters (properties) appropriate for the current analysis type while ignoring all other properties. If you switch the analysis type by setting the AnalysisType property of the model, the solver uses the appropriate set of properties corresponding to the new analysis type.

For more help migrating your existing code that uses ElectromagneticModel to the unified finite element workflow, see Migration from Domain-Specific to Unified Workflow.