Skip to documentation content
On this page
  1. Reference contract
  2. Contract
  3. Authoritative source

Piezoelectricity

div(sigma)+F=rho*d2u/dt2; div(D)=rho_q; sigma=C:strain-e^T E; D=e:strain+eps E

Reference contract

FieldValueDescription
areaStructural Mechanics / AC/DC
boundaryFeatures[{"assemblyRole":"essential","displayName":"Fixed Constraint","entityDimensions":["domain","boundary","edge","point"],"fields":[{"default":[0.0,0.0,0.0],"name":"value","required":true,"unit":"m","valueType":"vector"},{"default":[true,true,true],"name":"components","required":true,"valueType":"vector"}],"kind":"Fixed Constraint","multiple":true,"parentCategory":"physics","role":"exclusive","targetField":"u"},{"assemblyRole":"flux","displayName":"Boundary Load","entityDimensions":["boundary"],"fields":[{"default":[0.0,0.0,0.0],"name":"value","required":true,"unit":"N/m^2","valueType":"vector"}],"kind":"Boundary Load","multiple":true,"parentCategory":"physics","role":"contributing","targetField":"u"},{"assemblyRole":"essential","displayName":"Prescribed Displacement","entityDimensions":["boundary","edge","point"],"fields":[{"default":0.0,"name":"ux","required":true,"unit":"m","valueType":"scalar"},{"default":0.0,"name":"uy","required":true,"unit":"m","valueType":"scalar"},{"default":0.0,"name":"uz","required":true,"unit":"m","valueType":"scalar"},{"default":[true,true,true],"name":"components","required":true,"valueType":"vector"}],"kind":"Prescribed Displacement","multiple":true,"parentCategory":"physics","role":"exclusive","targetField":"u"},{"assemblyRole":"flux","displayName":"Edge Load","entityDimensions":["edge"],"fields":[{"default":[0.0,0.0,0.0],"name":"value","required":true,"unit":"N/m","valueType":"vector"}],"kind":"Edge Load","multiple":true,"parentCategory":"physics","role":"contributing","targetField":"u"},{"assemblyRole":"point-source","displayName":"Point Load","entityDimensions":["point"],"fields":[{"default":[0.0,0.0,0.0],"name":"value","required":true,"unit":"N","valueType":"vector"}],"kind":"Point Load","multiple":true,"parentCategory":"physics","role":"contributing","targetField":"u"},{"assemblyRole":"essential","displayName":"Ground","entityDimensions":["boundary","point"],"fields":{},"kind":"Ground","multiple":true,"parentCategory":"physics","role":"exclusive","targetField":"V"},{"assemblyRole":"essential","displayName":"Electric Potential","entityDimensions":["boundary","point"],"fields":[{"default":"0[V]","name":"value","required":true,"unit":"V","valueType":"expression"}],"kind":"Electric Potential","multiple":true,"parentCategory":"physics","role":"exclusive","targetField":"V"},{"assemblyRole":"essential","displayName":"Terminal","entityDimensions":["boundary","domain"],"fields":[{"default":"Terminal 1","name":"name","required":true,"valueType":"string"},{"default":"0[V]","name":"value","required":true,"unit":"V","valueType":"expression"},{"default":"","name":"circuitNode","required":false,"valueType":"string"}],"kind":"Terminal","multiple":true,"parentCategory":"physics","role":"exclusive","targetField":"V"},{"assemblyRole":"flux","displayName":"Surface Charge Density","entityDimensions":["boundary"],"fields":[{"default":"0[C/m^2]","name":"value","required":true,"unit":"C/m^2","valueType":"expression"}],"kind":"Surface Charge Density","multiple":true,"parentCategory":"physics","role":"contributing","targetField":"V"}]
childCategories["physics.domain","physics.boundary"]
defaultMaterialPZT-5H
displayNamePiezoelectricity
domainFeatures[{"assemblyRole":"material","displayName":"Piezoelectric Material","entityDimensions":["domain"],"fields":[{"default":"","name":"Material","required":true,"valueType":"material"},{"default":[[1.0,0.0,0.0],[0.0,1.0,0.0],[0.0,0.0,1.0]],"name":"Material orientation","required":true,"valueType":"matrix"}],"kind":"Piezoelectric Material","multiple":true,"parentCategory":"physics","required":true},{"assemblyRole":"volume-source","displayName":"Body Load and Charge","entityDimensions":["domain"],"fields":[{"default":[0.0,0.0,0.0,0.0],"name":"value","required":false,"valueType":"vector"}],"kind":"Body Load and Charge","multiple":true,"parentCategory":"physics","required":false},{"assemblyRole":"volume-source","displayName":"Body Load","entityDimensions":["domain"],"fields":[{"default":[0.0,0.0,0.0],"name":"value","required":false,"unit":"N/m^3","valueType":"vector"}],"kind":"Body Load","multiple":true,"parentCategory":"physics","required":false,"targetField":"u"},{"assemblyRole":"none","displayName":"Damping","entityDimensions":["domain"],"fields":[{"default":"0[1/s]","name":"Mass proportional coefficient","required":true,"unit":"1/s","valueType":"expression"},{"default":"0[s]","name":"Stiffness proportional coefficient","required":true,"unit":"s","valueType":"expression"},{"default":"[]","name":"Viscous constitutive matrix","required":false,"unit":"Pa*s","valueType":"matrix"}],"kind":"Damping","multiple":true,"parentCategory":"physics","required":false,"targetField":"u"},{"assemblyRole":"none","displayName":"Rotating Frame","entityDimensions":["domain"],"fields":[{"default":[0.0,0.0,0.0],"name":"Angular velocity","required":true,"unit":"rad/s","valueType":"vector"},{"default":[0.0,0.0,0.0],"name":"Angular acceleration","required":true,"unit":"rad/s^2","valueType":"vector"},{"default":[0.0,0.0,0.0],"name":"Translational acceleration","required":true,"unit":"m/s^2","valueType":"vector"},{"default":[0.0,0.0,0.0],"name":"Rotation origin","required":true,"unit":"m","valueType":"vector"}],"kind":"Rotating Frame","multiple":true,"parentCategory":"physics","required":false,"targetField":"u"},{"assemblyRole":"none","displayName":"Space Charge Density","entityDimensions":["domain"],"fields":[{"default":"0[C/m^3]","name":"value","required":true,"unit":"C/m^3","valueType":"expression"}],"kind":"Space Charge Density","multiple":true,"parentCategory":"physics","required":false}]
kindPiezoelectricity
materialSchema[{"default":"7500[kg/m^3]","name":"rho","rank":"scalar","required":true,"unit":"kg/m^3"},{"default":"6x6 matrix","name":"cE","rank":"matrix","required":true,"unit":"Pa"},{"default":"3x6 matrix","name":"e","rank":"matrix","required":true,"unit":"C/m^2"},{"default":"3x3 matrix","name":"epsS","rank":"matrix","required":true,"unit":"F/m"}]
publishedFields[{"components":3,"displayName":"Displacement","expression":"pze.u","name":"pze.u","plottable":true,"rank":"vector","studies":["stationary","eigenfrequency","eigenvalue","parametric-sweep","sensitivity","optimization","transient"],"unit":"m"},{"components":1,"displayName":"X displacement","expression":"component(pze.u,0)","name":"pze.ux","plottable":true,"rank":"scalar","studies":["stationary","eigenfrequency","eigenvalue","parametric-sweep","sensitivity","optimization","transient"],"unit":"m"},{"components":1,"displayName":"Y displacement","expression":"component(pze.u,1)","name":"pze.v","plottable":true,"rank":"scalar","studies":["stationary","eigenfrequency","eigenvalue","parametric-sweep","sensitivity","optimization","transient"],"unit":"m"},{"components":1,"displayName":"Z displacement","expression":"component(pze.u,2)","name":"pze.w","plottable":true,"rank":"scalar","studies":["stationary","eigenfrequency","eigenvalue","parametric-sweep","sensitivity","optimization","transient"],"unit":"m"},{"components":1,"displayName":"Displacement magnitude","expression":"norm(pze.u)","name":"pze.disp","plottable":true,"rank":"scalar","studies":["stationary","eigenfrequency","eigenvalue","parametric-sweep","sensitivity","optimization","transient"],"unit":"m"},{"components":1,"displayName":"Electric potential","expression":"pze.V","name":"pze.V","plottable":true,"rank":"scalar","studies":["stationary","eigenfrequency","eigenvalue","parametric-sweep","sensitivity","optimization","transient"],"unit":"V"},{"components":1,"displayName":"Coupled energy","expression":"energy","name":"pze.energy","plottable":true,"rank":"scalar","studies":["stationary"],"unit":"J"},{"components":1,"displayName":"Coupled compliance","expression":"2*pze.energy","name":"pze.compliance","plottable":true,"rank":"scalar","studies":["stationary"],"unit":"J"},{"components":1,"displayName":"von Mises stress","expression":"von_mises(pze.stress)","name":"pze.mises","plottable":true,"rank":"scalar","studies":["stationary"],"unit":"Pa"},{"components":6,"displayName":"Strain","expression":"strain(pze.u)","name":"pze.strain","plottable":true,"rank":"vector","studies":["stationary","transient"],"unit":"1"},{"components":6,"displayName":"Stress","expression":"cE:strain(pze.u)-transpose(e)*pze.E","name":"pze.stress","plottable":true,"rank":"vector","studies":["stationary","transient"],"unit":"Pa"},{"components":3,"displayName":"Electric field","expression":"-grad(pze.V)","name":"pze.E","plottable":true,"rank":"vector","studies":["stationary","transient"],"unit":"V/m"},{"components":3,"displayName":"Electric displacement","expression":"e:strain(pze.u)+epsS*pze.E","name":"pze.D","plottable":true,"rank":"vector","studies":["stationary","transient"],"unit":"C/m^2"},{"components":3,"displayName":"Velocity","expression":"d(pze.u,t)","name":"pze.velocity","plottable":true,"rank":"vector","studies":["transient"],"unit":"m/s"},{"components":3,"displayName":"Acceleration","expression":"d(pze.velocity,t)","name":"pze.acceleration","plottable":true,"rank":"vector","studies":["transient"],"unit":"m/s^2"},{"components":1,"displayName":"Electromechanical coupling energy","expression":"integral(strain(pze.u):transpose(e)*grad(pze.V))","name":"pze.couplingEnergy","plottable":true,"rank":"scalar","studies":["stationary"],"unit":"J"},{"components":3,"displayName":"Displacement","expression":"solid.u","name":"solid.u","plottable":true,"rank":"vector","studies":["stationary","eigenfrequency","eigenvalue","parametric-sweep","sensitivity","optimization","transient"],"unit":"m"},{"components":1,"displayName":"X displacement","expression":"component(solid.u,0)","name":"solid.ux","plottable":true,"rank":"scalar","studies":["stationary","parametric-sweep","sensitivity","optimization","transient"],"unit":"m"},{"components":1,"displayName":"Y displacement","expression":"component(solid.u,1)","name":"solid.uy","plottable":true,"rank":"scalar","studies":["stationary","parametric-sweep","sensitivity","optimization","transient"],"unit":"m"},{"components":1,"displayName":"Z displacement","expression":"component(solid.u,2)","name":"solid.uz","plottable":true,"rank":"scalar","studies":["stationary","parametric-sweep","sensitivity","optimization","transient"],"unit":"m"},{"components":1,"displayName":"Displacement magnitude","expression":"norm(solid.u)","name":"solid.disp","plottable":true,"rank":"scalar","studies":["stationary","eigenfrequency","eigenvalue","parametric-sweep","sensitivity","optimization","transient"],"unit":"m"},{"components":1,"displayName":"Strain energy","expression":"energy","name":"solid.strainEnergy","plottable":true,"rank":"scalar","studies":["stationary","parametric-sweep","sensitivity","optimization","transient"],"unit":"J"},{"components":1,"displayName":"Compliance","expression":"2*energy","name":"solid.compliance","plottable":true,"rank":"scalar","studies":["stationary","parametric-sweep","sensitivity","optimization"],"unit":"J"},{"components":6,"displayName":"Strain","expression":"strain(solid.u)","name":"solid.strain","plottable":true,"rank":"tensor","studies":["stationary","parametric-sweep","sensitivity","optimization","transient"],"unit":"1"},{"components":6,"displayName":"Stress","expression":"stress(solid.u)","name":"solid.stress","plottable":true,"rank":"tensor","studies":["stationary","parametric-sweep","sensitivity","optimization","transient"],"unit":"Pa"},{"components":1,"displayName":"von Mises stress","expression":"von_mises(solid.stress)","name":"solid.mises","plottable":true,"rank":"scalar","studies":["stationary","parametric-sweep","sensitivity","optimization","transient"],"unit":"Pa"},{"components":3,"displayName":"Velocity","expression":"d(solid.u,t)","name":"solid.velocity","plottable":true,"rank":"vector","studies":["transient"],"unit":"m/s"},{"components":3,"displayName":"Acceleration","expression":"d(solid.velocity,t)","name":"solid.acceleration","plottable":true,"rank":"vector","studies":["transient"],"unit":"m/s^2"},{"components":3,"displayName":"Coriolis force","expression":"-2*integral(rho*cross(solid.omega,solid.velocity))","name":"solid.coriolisForce","plottable":true,"rank":"vector","studies":["transient"],"unit":"N"},{"components":3,"displayName":"Net rotating-frame force","expression":"solid.frameForce","name":"solid.rotatingFrameForce","plottable":true,"rank":"vector","studies":["transient"],"unit":"N"},{"components":1,"displayName":"Kinetic energy","expression":"solid.kineticEnergy","name":"solid.kineticEnergy","plottable":true,"rank":"scalar","studies":["transient"],"unit":"J"},{"components":1,"displayName":"Damping power","expression":"solid.dampingPower","name":"solid.dampingPower","plottable":true,"rank":"scalar","studies":["transient"],"unit":"W"},{"components":1,"displayName":"Electric potential","expression":"es.V","name":"es.V","plottable":true,"rank":"scalar","studies":["stationary","transient","sensitivity","optimization"],"unit":"V"},{"components":1,"displayName":"Electrostatic energy functional","expression":"energy","name":"es.energy","plottable":true,"rank":"scalar","studies":["stationary","sensitivity","optimization"],"unit":"J"},{"components":1,"displayName":"Electrostatic compliance","expression":"2*energy","name":"es.compliance","plottable":true,"rank":"scalar","studies":["stationary","sensitivity","optimization"],"unit":"J"}]
statuscertified
studies["Stationary","Eigenfrequency","Eigenvalue","Parametric Sweep","Sensitivity","Optimization","Transient"]
studyCapabilities[{"certified":true,"differentiability":"exact-ad","kind":"stationary","reason":"september-2026-classroom verified contract: constitutive Jacobian finite-difference agreement and linear displacement scaling with applied voltage"},{"certified":true,"differentiability":"exact-ad","kind":"eigenfrequency","reason":"september-2026-classroom verified contract: coupled mechanical/electrical residuals and monotone spatial refinement"},{"certified":false,"differentiability":"exact-ad","kind":"eigenvalue","reason":"Generic piezoelectric eigenvalues are not certified as physical resonance frequencies; use the certified Eigenfrequency study."},{"certified":false,"differentiability":"exact-ad","kind":"parametric-sweep","reason":"Piezoelectricity parameter-sweep orchestration is not included in the September 2026 classroom support matrix."},{"certified":false,"differentiability":"exact-ad","kind":"sensitivity","reason":"Piezoelectricity sensitivity is disabled until verified per-parameter backend derivative solves are registered."},{"certified":false,"differentiability":"exact-ad","kind":"optimization","reason":"Piezoelectricity optimization is outside the September 2026 classroom support matrix."},{"certified":true,"differentiability":"exact-ad","kind":"transient","reason":"september-2026-classroom verified contract: second-order coupled modal time convergence with distinct variable-step operators"}]
tagpze
visibletrue

div(sigma)+F=rho*d2u/dt2; div(D)=rho_q; sigma=C:strain-e^T E; D=e:strain+eps E

Contract

PropertyValue
areaStructural Mechanics / AC/DC
boundaryFeatures[{"assemblyRole":"essential","displayName":"Fixed Constraint","entityDimensions":["domain","boundary","edge","point"],"fields":[{"default":[0.0,0.0,0.0],"name":"value","required":true,"unit":"m","valueType":"vector"},{"default":[true,true,true],"name":"components","required":true,"valueType":"vector"}],"kind":"Fixed Constraint","multiple":true,"parentCategory":"physics","role":"exclusive","targetField":"u"},{"assemblyRole":"flux","displayName":"Boundary Load","entityDimensions":["boundary"],"...
childCategories["physics.domain","physics.boundary"]
defaultMaterialPZT-5H
displayNamePiezoelectricity
domainFeatures[{"assemblyRole":"material","displayName":"Piezoelectric Material","entityDimensions":["domain"],"fields":[{"default":"","name":"Material","required":true,"valueType":"material"},{"default":[[1.0,0.0,0.0],[0.0,1.0,0.0],[0.0,0.0,1.0]],"name":"Material orientation","required":true,"valueType":"matrix"}],"kind":"Piezoelectric Material","multiple":true,"parentCategory":"physics","required":true},{"assemblyRole":"volume-source","displayName":"Body Load and Charge","entityDimensions":["domain"],"fi...
kindPiezoelectricity
materialSchema[{"default":"7500[kg/m^3]","name":"rho","rank":"scalar","required":true,"unit":"kg/m^3"},{"default":"6x6 matrix","name":"cE","rank":"matrix","required":true,"unit":"Pa"},{"default":"3x6 matrix","name":"e","rank":"matrix","required":true,"unit":"C/m^2"},{"default":"3x3 matrix","name":"epsS","rank":"matrix","required":true,"unit":"F/m"}]
publishedFields[{"components":3,"displayName":"Displacement","expression":"pze.u","name":"pze.u","plottable":true,"rank":"vector","studies":["stationary","eigenfrequency","eigenvalue","parametric-sweep","sensitivity","optimization","transient"],"unit":"m"},{"components":1,"displayName":"X displacement","expression":"component(pze.u,0)","name":"pze.ux","plottable":true,"rank":"scalar","studies":["stationary","eigenfrequency","eigenvalue","parametric-sweep","sensitivity","optimization","transient"],"unit":"m"...
statuscertified
studies["Stationary","Eigenfrequency","Eigenvalue","Parametric Sweep","Sensitivity","Optimization","Transient"]
studyCapabilities[{"certified":true,"differentiability":"exact-ad","kind":"stationary","reason":"september-2026-classroom verified contract: constitutive Jacobian finite-difference agreement and linear displacement scaling with applied voltage"},{"certified":true,"differentiability":"exact-ad","kind":"eigenfrequency","reason":"september-2026-classroom verified contract: coupled mechanical/electrical residuals and monotone spatial refinement"},{"certified":false,"differentiability":"exact-ad","kind":"eigenvalu...
tagpze
visibletrue

Authoritative source

Catalog
telion_backend.v2.python_api.feature_catalog
Identity
feature-category:physics:kind:pze:Piezoelectricity
Path
src/telion_backend/v2/python_api.py
Symbol
feature_catalog