pyccx.analysis Package

Classes

AnalysisError(expression, message)	Exception raised for errors generated during the analysis
AnalysisType(value)	The analysis types available in Calculix that may be used for analyses
MaterialAssignment(name, elementSet, material)	MaterialAssignment is a base class for defining the Element Types and Material that are specified for an ElementSet within the model.
ShellMaterialAssignment(name, elementSet, ...)	The ShellMaterialAssignment class is used to select shell elements for the selected elements in a provided ElementSet with the given Material.
Simulation(meshModel)	Provides the class for running a Calculix Simulation
SolidMaterialAssignment(name, elementSet, ...)	SolidMaterialAssignment designates elements as solid 3D continuum elements, for the selected elements in a provided ElementSet with the given Material.

pyccx.bc Package

Classes

Acceleration(target[, direction, mag, name, ...])	The Acceleration Boundary Condition applies an acceleration term across a Volume (i.e. Element Set) during a structural analysis.
BoundaryCondition(name, target[, amplitude, ...])	Base class for all boundary conditions
BoundaryConditionType(value)	Boundary condition type specifies which type of analyses the boundary condition may be applied to.
Film(target[, h, TAmbient, name, amplitude, ...])	The film or convective heat transfer boundary condition applies the Newton's law of cooling \(q = h_{ c}\left(T-T_{amb}\right)\) to specified faces of boundaries elements (correctly ordered according to Calculix's requirements).
Fixed(target[, dof, values, name, ...])	The fixed boundary condition removes or sets the DOF (e.g. displacement components, temperature) specifically on a NodeSet.
Force(target[, name, amplitude, timeDelay])	The Force Boundary applies a uniform force directly to nodes.
HeatFlux(target[, flux, name, amplitude, ...])	The flux boundary condition applies a uniform external heat flux \(q\) to faces of surface boundaries elements (correctly ordered according to Calculix's requirements).
Pressure(target[, magnitude, name, ...])	The Pressure boundary condition applies a uniform pressure applied to the faces across an element boundary.
Radiation(target[, epsilon, TAmbient, name, ...])	The radiation boundary condition applies Black-body radiation using the Stefan-Boltzmann Law, \(q_{rad} = \epsilon \sigma_b\left(T-T_{amb}\right)^4\), which is imposed on the faces of boundary elements (correctly ordered according to Calculix's requirements).

pyccx.core Module

Classes

Amplitude(name[, profile])
Any(*args, **kwargs)	Special type indicating an unconstrained type.
Connector(name[, nodeset, refNode])	A Connector is a rigid connector between a set of nodes and an (optional) reference node.
DOF(value)	Provides a reference to the typical degrees-of-freedom (DOF) used for setting boundary conditions and displaying the required output in Calculix.
ElementSet(name, elIds)	An element set is basic entity for storing a list of element ids as part of a referencable set, typically used amongst boundary conditions and assignments .The set remains constant without any dynamic referencing to any underlying geometric entities.
IntEnum(value)	Enum where members are also (and must be) ints
MeshSet(name)	The Mesh set is a basic entity for storing node and element set lists that are used for creating sets across both node and element types.
ModelObject(name[, label])
NodeSet(name, nodes)	A NodeSet is basic entity for storing a list of Node Ids.
SurfaceNodeSet(name, nodalSet)	A surface-node set is a basic entity for storing element face lists, typically for setting directional fluxes onto surface elements based on the element ordering.
SurfaceSet(name, surfacePairs)	A surface-set is a basic entity for storing element face lists, typically for setting directional fluxes onto surface elements based on the element ordering.

pyccx.loadcase Package

Classes

LoadCase(name[, loadCaseType, resultSets])	A unique Load case defines a set of simulation analysis conditions and a set of boundary conditions to apply to the domain.
LoadCaseType(value)	Enum Class specifies the Load Case type

pyccx.material Package

Classes

ElastoPlasticMaterial(name)	Represents a generic non-linear elastic/plastic material which may be used in both structural, and thermal type analyses
Material(name)	Base class for all material model definitions

pyccx.results Package

Classes

ElementResult(elSet)	Including an ElementResult in a LoadCase will inform Calcuix to save the elemental integration properties to the (.dat) file for the selected ElementSet in the chosen working directory specified in the Simulation.
NodalResult([nodeSet])	The NodalResult when attached to a LoadCase will inform Calculix to save the nodal values onto the file (.frd) for the selected nodes attached in the specified NodeSet.
Result()	Base Class for all Calculix Results
ResultProcessor(jobName)	ResultProcessor takes the output (results) file from the Calculix simulation, specified in the working directory for the Simulation.
ResultsValue()	The following class attributes are available for post-processing the result file and are used as an enumeration for selecting the desired results to be saved to the .frd and .dat file processed in the ResultProcessor.

pyccx.mesh Package

Functions

getNodesFromRegion(surfaceRegionName, model)	Gets the nodes for a specified surface region
getNodesFromVolume(volumeName, model)	Gets the nodes for a specified volume
getSurfaceFacesFromRegion(regionName, model)	Gets the faces from a surface region, which are compatible with GMSH in order to apply surface BCs to.
removeSurfaceMeshes(model)	In order to assign face based boundary conditions to surfaces (e.g. flux, convection), the surface mesh is compared to the volumetric mesh to identify the actual surface mesh.

Classes

Ent()	Entity types for Elementary MSH Geometry
Mesher(modelName)	The Mesher class provides the base interface built upon the GMSH-SDK API operations.
MeshingAlgorithm2D(value)
MeshingAlgorithm3D(value)
RecombinationAlgorithm(value)