The MagneticVectorPotentialBC object stores the data for a magnetic vector potential boundary condition.
The MagneticVectorPotentialBC object is derived from the BoundaryCondition object.
import load mdb.models[name].boundaryConditions[name]
This method creates a MagneticVectorPotentialBC object.
mdb.models[name].MagneticVectorPotentialBC
Required arguments
A String specifying the boundary condition repository key.
A String specifying the name of the step in which the boundary condition is created.
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET
A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
None or a DatumCsys object specifying the local coordinate system of the boundary condition's degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.
Return value
A MagneticVectorPotentialBC object.
Exceptions
This method modifies the data for an existing MagneticVectorPotentialBC object in the step where it is created.
Required arguments
Optional arguments
The optional arguments to setValues are the same as the arguments to the MagneticVectorPotentialBC method, except for the name and createStepName arguments.
Return value
Exceptions
This method modifies the propagating data for an existing MagneticVectorPotentialBC object in the specified step.
Required argument
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 1-direction. Possible values for the SymbolicConstant are SET and UNCHANGED.
A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 2-direction. Possible values for the SymbolicConstant are SET and UNCHANGED.
A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 3-direction. Possible values for the SymbolicConstant areSET and UNCHANGED.
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous analysis step. FREED should be used if the boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.
Return value
Exceptions
The MagneticVectorPotentialBC object can have the following members:
A String specifying the boundary condition repository key.
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
A Region object specifying the region to which the boundary condition is applied.
None or a DatumCsys object specifying the local coordinate system of the boundary condition's degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.