Public Member Functions
def	ccx_run (self)

def	check_prerequisites (self)

def	find_analysis (self)

def	find_solver (self)

def	find_solver_analysis (self)

def	get_ccx_version (self)

def	has_no_material_assigned (self)

def	has_nonpositive_jacobians (self)

def	load_results (self)

def	load_results_ccxdat (self)

def	load_results_ccxfrd (self)

def	purge_results (self)

def	reset_all (self)

def	reset_mesh_purge_results_checked (self)

def	run (self)

def	set_base_name (self, base_name=None)

def	set_inp_file_name (self, inp_file_name=None)

def	setup_ccx (self, ccx_binary=None, ccx_binary_sig="CalculiX")

def	setup_working_dir (self, param_working_dir=None, create=False)

def	start_ccx (self)

def	update_objects (self)

def	write_inp_file (self)

Public Attributes
	analysis

	base_name

	ccx_binary

	ccx_binary_present

	ccx_prefs

	ccx_stderr

	ccx_stdout

	fem_prefs

	inp_file_name

	member

	mesh

	result_object

	results_present

	solver

	test_mode

	working_dir

Static Public Attributes
	finished = QtCore.Signal(int)

Detailed Description

Attributes
----------
analysis : Fem::FemAnalysis
    FEM group analysis object
    has to be present, will be set in __init__
solver : Fem::FemSolverObjectPython
    FEM solver object
    has to be present, will be set in __init__
base_name : str
    name of .inp/.frd file (without extension)
    It is used to construct .inp file path that is passed to CalculiX ccx
ccx_binary : str
working_dir : str
results_present : bool
    indicating if there are calculation results ready for us
members : class femtools/membertools/AnalysisMember
    contains references to all analysis member except solvers and mesh
    Updated with update_objects

Member Function Documentation

◆ ccx_run()

def femtools.ccxtools.FemToolsCcx.ccx_run ( self )

Referenced by femtools.ccxtools.FemToolsCcx.run().

◆ check_prerequisites()

def femtools.ccxtools.FemToolsCcx.check_prerequisites ( self )

References femsolver.writerbase.FemInputWriter.analysis, femmesh.gmshtools.GmshTools.analysis, femtools.ccxtools.FemToolsCcx.analysis, femsolver.elmer.writer.Writer.analysis, femtaskpanels.task_mesh_gmsh._TaskPanel.analysis, femtools.checksanalysis.check_analysismember(), femtools.ccxtools.FemToolsCcx.member, femsolver.fenics.fenics_tools.XDMFReader.mesh, femtools.ccxtools.FemToolsCcx.mesh, femtools.ccxtools.FemToolsCcx.solver, femsolver.elmer.writer.Writer.solver, femsolver.run.BaseTask.solver, femsolver.run.Machine.solver, femtools.ccxtools.FemToolsCcx.working_dir, and femmesh.gmshtools.GmshTools.working_dir.

Referenced by femtools.ccxtools.FemToolsCcx.run().

◆ find_analysis()

def femtools.ccxtools.FemToolsCcx.find_analysis ( self )

References femsolver.writerbase.FemInputWriter.analysis, femmesh.gmshtools.GmshTools.analysis, femtools.ccxtools.FemToolsCcx.analysis, femsolver.elmer.writer.Writer.analysis, and femtaskpanels.task_mesh_gmsh._TaskPanel.analysis.

◆ find_solver()

def femtools.ccxtools.FemToolsCcx.find_solver ( self )

References femsolver.writerbase.FemInputWriter.analysis, femmesh.gmshtools.GmshTools.analysis, femtools.ccxtools.FemToolsCcx.analysis, femsolver.elmer.writer.Writer.analysis, femtaskpanels.task_mesh_gmsh._TaskPanel.analysis, femtools.ccxtools.FemToolsCcx.solver, femsolver.elmer.writer.Writer.solver, femsolver.run.BaseTask.solver, and femsolver.run.Machine.solver.

◆ find_solver_analysis()

def femtools.ccxtools.FemToolsCcx.find_solver_analysis ( self )

get the analysis group the solver belongs to

References femsolver.writerbase.FemInputWriter.analysis, femmesh.gmshtools.GmshTools.analysis, femtools.ccxtools.FemToolsCcx.analysis, femsolver.elmer.writer.Writer.analysis, femtaskpanels.task_mesh_gmsh._TaskPanel.analysis, femtools.ccxtools.FemToolsCcx.solver, femsolver.elmer.writer.Writer.solver, femsolver.run.BaseTask.solver, and femsolver.run.Machine.solver.

◆ get_ccx_version()

def femtools.ccxtools.FemToolsCcx.get_ccx_version ( self )

References femtools.ccxtools.FemToolsCcx.ccx_binary, and femtools.ccxtools.FemToolsCcx.setup_ccx().

◆ has_no_material_assigned()

def femtools.ccxtools.FemToolsCcx.has_no_material_assigned ( self )

References femtools.ccxtools.FemToolsCcx.ccx_stdout, femsolver.fenics.fenics_tools.XDMFReader.mesh, and femtools.ccxtools.FemToolsCcx.mesh.

Referenced by femtools.ccxtools.FemToolsCcx.ccx_run().

◆ has_nonpositive_jacobians()

def femtools.ccxtools.FemToolsCcx.has_nonpositive_jacobians ( self )

References femtools.ccxtools.FemToolsCcx.ccx_stdout, femsolver.fenics.fenics_tools.XDMFReader.mesh, and femtools.ccxtools.FemToolsCcx.mesh.

Referenced by femtools.ccxtools.FemToolsCcx.ccx_run().

◆ load_results()

def femtools.ccxtools.FemToolsCcx.load_results ( self )

References femsolver.calculix.tasks.Results.load_results_ccxdat(), femtools.ccxtools.FemToolsCcx.load_results_ccxdat(), femsolver.calculix.tasks.Results.load_results_ccxfrd(), femtools.ccxtools.FemToolsCcx.load_results_ccxfrd(), and femtools.ccxtools.FemToolsCcx.results_present.

Referenced by femtools.ccxtools.FemToolsCcx.run().

◆ load_results_ccxdat()

def femtools.ccxtools.FemToolsCcx.load_results_ccxdat ( self )

Load results of ccx calculations from .dat file.

References femsolver.writerbase.FemInputWriter.analysis, femmesh.gmshtools.GmshTools.analysis, femtools.ccxtools.FemToolsCcx.analysis, femsolver.elmer.writer.Writer.analysis, femtaskpanels.task_mesh_gmsh._TaskPanel.analysis, and femtools.ccxtools.FemToolsCcx.inp_file_name.

Referenced by femtools.ccxtools.FemToolsCcx.load_results().

◆ load_results_ccxfrd()

def femtools.ccxtools.FemToolsCcx.load_results_ccxfrd ( self )

Load results of ccx calculations from .frd file.

References femsolver.writerbase.FemInputWriter.analysis, femmesh.gmshtools.GmshTools.analysis, femtools.ccxtools.FemToolsCcx.analysis, femsolver.elmer.writer.Writer.analysis, femtaskpanels.task_mesh_gmsh._TaskPanel.analysis, femtools.ccxtools.FemToolsCcx.inp_file_name, femtools.ccxtools.FemToolsCcx.results_present, femtools.ccxtools.FemToolsCcx.solver, femsolver.elmer.writer.Writer.solver, femsolver.run.BaseTask.solver, and femsolver.run.Machine.solver.

Referenced by femtools.ccxtools.FemToolsCcx.load_results().

◆ purge_results()

def femtools.ccxtools.FemToolsCcx.purge_results ( self )

Remove all result objects and result meshes from an analysis group

References femsolver.writerbase.FemInputWriter.analysis, femmesh.gmshtools.GmshTools.analysis, femtools.ccxtools.FemToolsCcx.analysis, femsolver.elmer.writer.Writer.analysis, and femtaskpanels.task_mesh_gmsh._TaskPanel.analysis.

Referenced by femtools.ccxtools.FemToolsCcx.reset_all().

◆ reset_all()

def femtools.ccxtools.FemToolsCcx.reset_all ( self )

Reset mesh color, deformation and removes all result objects

References femsolver.writerbase.FemInputWriter.analysis, femmesh.gmshtools.GmshTools.analysis, femtools.ccxtools.FemToolsCcx.analysis, femsolver.elmer.writer.Writer.analysis, femtaskpanels.task_mesh_gmsh._TaskPanel.analysis, femsolver.calculix.tasks.Results.purge_results(), femsolver.z88.tasks.Results.purge_results(), and femtools.ccxtools.FemToolsCcx.purge_results().

◆ reset_mesh_purge_results_checked()

def femtools.ccxtools.FemToolsCcx.reset_mesh_purge_results_checked ( self )

Reset mesh color, deformation and removes all result objects
if preferences to keep them is not set.

◆ run()

def femtools.ccxtools.FemToolsCcx.run ( self )

References femtools.ccxtools.FemToolsCcx.ccx_run(), femtools.ccxtools.FemToolsCcx.check_prerequisites(), femtools.ccxtools.FemToolsCcx.inp_file_name, femtools.ccxtools.FemToolsCcx.load_results(), femtools.ccxtools.FemToolsCcx.setup_working_dir(), femtools.ccxtools.FemToolsCcx.update_objects(), and femtools.ccxtools.FemToolsCcx.write_inp_file().

◆ set_base_name()

def femtools.ccxtools.FemToolsCcx.set_base_name	(	self,
		base_name = `None`
	)

Set base_name

Parameters
----------
base_name : str, optional
    base_name base name of .inp/.frd file (without extension).
    It is used to construct .inp file path that is passed to CalculiX ccx

References femtools.ccxtools.FemToolsCcx.base_name, and femtools.ccxtools.FemToolsCcx.set_inp_file_name().

◆ set_inp_file_name()

def femtools.ccxtools.FemToolsCcx.set_inp_file_name	(	self,
		inp_file_name = `None`
	)

Set inp file name. Normally inp file name is set by write_inp_file.
That name is also used to determine location and name of frd result file.

Parameters
----------
inp_file_name : str, optional
    input file name path

Referenced by femtools.ccxtools.FemToolsCcx.set_base_name(), and femtools.ccxtools.FemToolsCcx.setup_working_dir().

◆ setup_ccx()

def femtools.ccxtools.FemToolsCcx.setup_ccx	(	self,
		ccx_binary = `None`,
		ccx_binary_sig = `"CalculiX"`
	)

Set Calculix binary path and validate its execution.

Parameters
----------
ccx_binary : str, optional
    It defaults to `None`. The path to the `ccx` binary. If it is `None`,
    the path is guessed.
ccx_binary_sig : str, optional
    Defaults to 'CalculiX'. Expected output from `ccx` when run empty.

Raises
------
Exception

References femtools.ccxtools.FemToolsCcx.ccx_binary.

Referenced by femtools.ccxtools.FemToolsCcx.ccx_run(), and femtools.ccxtools.FemToolsCcx.get_ccx_version().

◆ setup_working_dir()

def femtools.ccxtools.FemToolsCcx.setup_working_dir	(	self,
		param_working_dir = `None`,
		create = `False`
	)

Set working dir for solver execution.

Parameters
----------
param_working_dir :  str, optional
    directory to be used for writing
create : bool, optional
    Should the working directory be created if it does not exist

References femtools.ccxtools.FemToolsCcx.set_inp_file_name(), femtools.ccxtools.FemToolsCcx.solver, femsolver.elmer.writer.Writer.solver, femsolver.run.BaseTask.solver, femsolver.run.Machine.solver, femtools.ccxtools.FemToolsCcx.working_dir, and femmesh.gmshtools.GmshTools.working_dir.

Referenced by femtools.ccxtools.FemToolsCcx.run().