C++ API entities

class xc.EntMdlr

Bases: xc.SetEstruct

In((EntMdlr)arg1, (GeomObj3d)arg2, (float)arg3) → bool :

In(geomObject,tolerance) Return true if this object lies inside the geometric object.

C++ signature :

bool In(XC::EntMdlr {lvalue},GeomObj3d,double)

Out((EntMdlr)arg1, (GeomObj3d)arg2, (float)arg3) → bool :

Out(geomObject,tolerance) Return true if this object lies outside the geometric object.

C++ signature :

bool Out(XC::EntMdlr {lvalue},GeomObj3d,double)

property description

Description (string) of the entity.

dist((EntMdlr)arg1, (Pos3d)arg2) → float :

Return the distance to the point argument.

C++ signature :

double dist(XC::EntMdlr {lvalue},Pos3d)

dist2((EntMdlr)arg1, (Pos3d)arg2) → float :

Return the square of the distance to the point argument.

C++ signature :

double dist2(XC::EntMdlr {lvalue},Pos3d)

getConnectedElements((EntMdlr)arg1, (Node)arg2) → list :

Returns the elements of this object connected to the given node.

C++ signature :

boost::python::list getConnectedElements(XC::EntMdlr {lvalue},XC::Node const*)

getElement((EntMdlr)arg1, (int)arg2, (int)arg3, (int)arg4) → Element :

Returns (i,j,k) element.

C++ signature :

XC::Element* getElement(XC::EntMdlr {lvalue},unsigned long,unsigned long,unsigned long)

getNearestElement((EntMdlr)arg1, (Pos3d)arg2) → Element :

Returns nearest element.

C++ signature :

XC::Element* getNearestElement(XC::EntMdlr {lvalue},Pos3d)

getNearestNode((EntMdlr)arg1, (Pos3d)arg2) → Node :

Returns nearest node.

C++ signature :

XC::Node* getNearestNode(XC::EntMdlr {lvalue},Pos3d)

getNode((EntMdlr)arg1, (int)arg2, (int)arg3, (int)arg4) → Node :

Returns (i,j,k) node.

C++ signature :

XC::Node* getNode(XC::EntMdlr {lvalue},unsigned long,unsigned long,unsigned long)

getPosCentroid((EntMdlr)arg1) → Pos3d :

Returns the centroid of the object.

C++ signature :

Pos3d getPosCentroid(XC::EntMdlr {lvalue})

getSimpsonWeights((EntMdlr)arg1, (str)arg2, (str)arg3, (int)arg4, (int)arg5, (int)arg6) → Vector :

Returns weights for Simpson’s rule integration.

C++ signature :

XC::Vector getSimpsonWeights(XC::EntMdlr {lvalue},std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >,std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >,unsigned long,unsigned long,unsigned long)

class xc.Pnt

Bases: xc.EntMdlr

property connectedEdges

Returns the lines connected to this point.

property connectedEdgesTags

Returns the tags of the lines connected to the point.

property connectedSurfaces

Returns the surfaces connected to the point.

getAverageElementSize((Pnt)arg1) → float :

Returns the centroid of the object.

C++ signature :

double getAverageElementSize(XC::Pnt {lvalue})

getConnectedEdges((Pnt)arg1, (SetBase)arg2) → list :

Returns the lines from the given set connected to this point.

C++ signature :

boost::python::list getConnectedEdges(XC::Pnt {lvalue},XC::SetBase const*)

getConnectedSurfaces((Pnt)arg1, (SetBase)arg2) → list :

Returns the surfaces of the given set connected to the point.

C++ signature :

boost::python::list getConnectedSurfaces(XC::Pnt {lvalue},XC::SetBase const*)

property getNLines

TO DEPRECATE, returns number of lines that touch the point.

getNode((Pnt)arg1) → Node :

Returns point’s node.

C++ signature :

XC::Node* getNode(XC::Pnt {lvalue})

getNumConnectedEdges((Pnt)arg1, (SetBase)arg2) → int :

Returns number of edges from the given set that touch this point.

C++ signature :

unsigned long getNumConnectedEdges(XC::Pnt {lvalue},XC::SetBase const*)

property getPos

TO DEPRECATE: return the position vector of the point.

property getTagNode

Returns node’s tag.

getVectorPos((Pnt)arg1) → Vector3d :

Return the position vector of the point.

C++ signature :

Vector3d getVectorPos(XC::Pnt {lvalue})

property hasNode

True if the point has a node.

property numConnectedEdges

Returns number of edges that touch this point.

property pos

return the position of the point.

setNode((Pnt)arg1, (Node)arg2) → Node :

Assigns the given node to this point.

C++ signature :

XC::Node const* setNode(XC::Pnt {lvalue},XC::Node*)

setPos((Pnt)arg1, (Pos3d)arg2) → None :

set the position vector of the point.

C++ signature :

void setPos(XC::Pnt {lvalue},Pos3d)

class xc.Face

Bases: xc.CmbEdge

addHole((Face)arg1, (PolygonalFace)arg2) → None :

Add a hole to the face.

C++ signature :

void addHole(XC::Face {lvalue},XC::PolygonalFace*)

property connectedBodies

Returns the bodies connected to this surface.

property connectedSurfaces

Returns the surfaces connected to this surface.

getArea((Face)arg1) → float :

Return the face area.

C++ signature :

double getArea(XC::Face {lvalue})

getCommonEdges((Face)arg1, (Face)arg2) → list :

Return a list with the edges that are common with the given surface.

C++ signature :

boost::python::list getCommonEdges(XC::Face {lvalue},XC::Face)

getConnectedBodies((Face)arg1, (SetBase)arg2) → list :

Returns the bodies of the given set that are connected to this surface.

C++ signature :

boost::python::list getConnectedBodies(XC::Face {lvalue},XC::SetBase const*)

getConnectedSurfaces((Face)arg1, (SetBase)arg2) → list :

Returns the surfaces of the given set that are connected to this one.

C++ signature :

boost::python::list getConnectedSurfaces(XC::Face {lvalue},XC::SetBase const*)

getContour((Face)arg1) → Polyline3d :

Return the face contour as a 3D polyline.

C++ signature :

Polyline3d getContour(XC::Face {lvalue})

getHoles((Face)arg1) → list :

Return a list with the face holes in it.

C++ signature :

boost::python::list getHoles(XC::Face {lvalue})

getOppositeEdge((Face)arg1, (Edge)arg2) → Edge :

Return the opposite side with respect to the one being passed as parameter.

C++ signature :

XC::Edge* getOppositeEdge(XC::Face {lvalue},XC::Edge)

getPlane((Face)arg1) → Plane3d :

Return the plane containing the face.

C++ signature :

Plane getPlane(XC::Face {lvalue})

getPolygon((Face)arg1) → Polygon3d :

Return the contour as a 3D polygon.

C++ signature :

Polygon3d getPolygon(XC::Face {lvalue})

isFlat((Face)arg1, (float)arg2) → bool :

Return true if the face is flat.

C++ signature :

bool isFlat(XC::Face {lvalue},double)

isWarped((Face)arg1, (float)arg2) → bool :

Return true if the face is not flat.

C++ signature :

bool isWarped(XC::Face {lvalue},double)

property nDivI

get/set the number of divisions of the even sides of the surface.

property nDivJ

get/set the number of divisions of the odd sides of the surface.

orientation((Face)arg1, (Pos3d)arg2) → str :

Return the orientation of the face.

C++ signature :

std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > orientation(XC::Face {lvalue},Pos3d)

revolve((Face)arg1, (int)arg2) → None :

Revolve the vertex sequence.

C++ signature :

void revolve(XC::Face {lvalue},int)

setElemSize((Face)arg1, (float)arg2, (bool)arg3) → None :

setElementSize(sz, mustBeEven) set the element size on the sides of the surface; if mustBeEven is true the number of divisions in each side is forced to the next even number.

C++ signature :

void setElemSize(XC::Face {lvalue},double,bool)

setElemSizeI((Face)arg1, (float)arg2) → None :

setElementSizeI(sz) set the element size on the even sides of the surface.

C++ signature :

void setElemSizeI(XC::Face {lvalue},double)

setElemSizeIJ((Face)arg1, (float)arg2, (float)arg3) → None :

setElementSizeIJ(szI, szJ) set the element size on the even and odd sides of the surface.

C++ signature :

void setElemSizeIJ(XC::Face {lvalue},double,double)

setElemSizeJ((Face)arg1, (float)arg2) → None :

setElementSizeJ(sz) set the element size on the odd sides of the surface.

C++ signature :

void setElemSizeJ(XC::Face {lvalue},double)

setIOrientation((Face)arg1, (Vector3d)arg2) → int :

Set the face i vector as close as possible to the given vector.

C++ signature :

int setIOrientation(XC::Face {lvalue},Vector3d)

setKOrientation((Face)arg1, (Vector3d)arg2) → None :

Set the orientation of the face normal according to the vector argument.

C++ signature :

void setKOrientation(XC::Face {lvalue},Vector3d)

class xc.QuadSurface

Bases: xc.Face

defGridPoints((QuadSurface)arg1, (list)arg2) → None :

C++ signature :

void defGridPoints(XC::QuadSurface {lvalue},boost::python::list)

property getIVector

Return the local x vector.

property getJVector

Return the local x vector.

property getKVector

Return the local x vector.

getLocalAxes((QuadSurface)arg1) → Matrix :

Return the surface local axes as matrix rows: [[x1,y1,z1],[x2,y2,z2],…·] .

C++ signature :

XC::Matrix getLocalAxes(XC::QuadSurface {lvalue})

class xc.Body

Bases: xc.EntMdlr

Six-faced body.

getVertex((Body)arg1, (int)arg2) → Pnt :

Return the vertex corresponding to the index argument.

C++ signature :

XC::Pnt const* getVertex(XC::Body {lvalue},unsigned long)

getVertices((Body)arg1) → list :

Return the vertices (or points) that define the body in a Python list.

C++ signature :

boost::python::list getVertices(XC::Body {lvalue})

getVolume((Body)arg1) → float :

Return the volume of the body.

C++ signature :

double getVolume(XC::Body {lvalue})

points((Body)arg1) → list :

Return the points (or vertices) that define the body in a Python list.

C++ signature :

boost::python::list points(XC::Body {lvalue})

class xc.Block

Bases: xc.Body

Six-faced solid.

getFace((Block)arg1, (int)arg2) → BodyFace :

Return the face corresponding to the indes argument.

C++ signature :

XC::Body::BodyFace const* getFace(XC::Block {lvalue},unsigned long)

getHexahedron((Block)arg1) → Hexahedron3d :

Return an hexahedron with the same vertices than this block.

C++ signature :

Hexahedron3d getHexahedron(XC::Block {lvalue})

getPositions((Block)arg1) → list :

Return the positions that will be used for the nodes when meshing.

C++ signature :

boost::python::list getPositions(XC::Block {lvalue})

property nDivI

Number or divisions in I direction.

property nDivJ

Number or divisions in J direction.

property nDivK

Number or divisions in K direction.

class xc.UniformGrid

Bases: xc.EntMdlr

property Lx

Length in x direction.

property Ly

Length in y direction.

property Lz

Length in z direction.

property nDivX

Number or divisions in x direction.

property nDivY

Number or divisions in y direction.

property nDivZ

Number or divisions in z direction.

class xc.MapCMEdges

Bases: xc.ModelComponentContainerBase

exists((MapCMEdges)arg1, (int)arg2) → bool :

C++ signature :

bool exists(XC::ModelComponentContainer<XC::Edge> {lvalue},unsigned long)

get((MapCMEdges)arg1, (int)arg2) → Edge :

C++ signature :

XC::Edge* get(XC::ModelComponentContainer<XC::Edge> {lvalue},unsigned long)

getKeys((MapCMEdges)arg1) → list :

C++ signature :

boost::python::list getKeys(XC::ModelComponentContainer<XC::Edge> {lvalue})

class xc.MapCMFaces

Bases: xc.ModelComponentContainerBase

exists((MapCMFaces)arg1, (int)arg2) → bool :

C++ signature :

bool exists(XC::ModelComponentContainer<XC::Face> {lvalue},unsigned long)

get((MapCMFaces)arg1, (int)arg2) → Face :

C++ signature :

XC::Face* get(XC::ModelComponentContainer<XC::Face> {lvalue},unsigned long)

getKeys((MapCMFaces)arg1) → list :

C++ signature :

boost::python::list getKeys(XC::ModelComponentContainer<XC::Face> {lvalue})

class xc.map_faces

Bases: xc.MapCMFaces

genMesh((map_faces)arg1, (meshDir)arg2) → None :

Generate mesh.

C++ signature :

void genMesh(XC::EntityMap<XC::Face> {lvalue},XC::meshing_dir)

class xc.MapCMBodies

Bases: xc.ModelComponentContainerBase

exists((MapCMBodies)arg1, (int)arg2) → bool :

C++ signature :

bool exists(XC::ModelComponentContainer<XC::Body> {lvalue},unsigned long)

get((MapCMBodies)arg1, (int)arg2) → Body :

C++ signature :

XC::Body* get(XC::ModelComponentContainer<XC::Body> {lvalue},unsigned long)

getKeys((MapCMBodies)arg1) → list :

C++ signature :

boost::python::list getKeys(XC::ModelComponentContainer<XC::Body> {lvalue})

class xc.MapBodies

Bases: xc.map_bodies

checkNDivs((MapBodies)arg1) → bool :

Check the number of divisions.

C++ signature :

bool checkNDivs(XC::BodyMap {lvalue})

conciliaNDivs((MapBodies)arg1) → bool :

C++ signature :

bool conciliaNDivs(XC::BodyMap {lvalue})

get((MapBodies)arg1, (int)arg2) → Body :

Return the i-th face.

C++ signature :

XC::Body* get(XC::BodyMap {lvalue},unsigned long)

getAverageVolume((MapBodies)arg1) → float :

Return the average volume of the bodies.

C++ signature :

double getAverageVolume(XC::BodyMap {lvalue})

getNDivErrorsTags((MapBodies)arg1) → list :

Return the identifiers of the line that have an incompatible number of divisions.

C++ signature :

boost::python::list getNDivErrorsTags(XC::BodyMap {lvalue})

newBlockPts((MapBodies)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5, (int)arg6, (int)arg7, (int)arg8, (int)arg9) → Block :

Creates a hexahedrical block.

C++ signature :

XC::Block* newBlockPts(XC::BodyMap {lvalue},unsigned long,unsigned long,unsigned long,unsigned long,unsigned long,unsigned long,unsigned long,unsigned long)

class xc.MapCMUgrids

Bases: xc.ModelComponentContainerBase

exists((MapCMUgrids)arg1, (int)arg2) → bool :

C++ signature :

bool exists(XC::ModelComponentContainer<XC::UniformGrid> {lvalue},unsigned long)

get((MapCMUgrids)arg1, (int)arg2) → UniformGrid :

C++ signature :

XC::UniformGrid* get(XC::ModelComponentContainer<XC::UniformGrid> {lvalue},unsigned long)

getKeys((MapCMUgrids)arg1) → list :

C++ signature :

boost::python::list getKeys(XC::ModelComponentContainer<XC::UniformGrid> {lvalue})

class xc.map_ugrids

Bases: xc.MapCMUgrids