System Modules

solvcon.conf

solvcon.conf.env

The global singleton of Solvcon to provide configuration for other components of SOLVCON.

class solvcon.conf.Solvcon

The configuration class.

Variables:

• pydir – The path of the solvcon package that is running.
• pkgdir – The path that contains solvcon package that is running.
• libdir – The path of the compiled binary of SOLVCON.
• datadir – The path of the static data of SOLVCON.
• projdir – The path that hosts a SOLVCON project.
• logfile – The stream that saves runtime output.
• logfn – The (absolute) path of the logfile.
• modnames – Names of SOLVCON applications.
• command – Unknown
• mpi – The MPI runtime interface.
• scu – The CUDA runtime interface.

__weakref__

list of weak references to the object (if defined)

enable_applications()

Enable a SOLVCON application by importing the module (or package).

Returns:Nothing.

find_scdata_mesh()

Find the mesh directory of the scdata from the current working directory all the way to the root.

Returns:The path to the supplemental SOLVCON mesh data. Return type:str

get_entry_point()

If the entry point is invoked by searching in path, just return it. If the entry point is invoked by specifying a location, return the absolute path of the entry script/code.

Returns:The invoked name. Return type:str

solvcon.helper

Helping functionalities.

class solvcon.helper.Cubit(cmds, ndim, large=False)

Variables:

• cmds – Commands to be sent to Cubit.
• ndim – Number of dimensions.
• large – Flag to use large file of Genesis/ExodusII or not.

Delegate Cubit command through journaling file and load the generated mesh.

__call__()

Returns:The loaded Genesis object. Return type:solvcon.io.genesis.Genesis

Launch Cubit for generating mesh and then load the generated Genesis/ExodusII file.

__weakref__

list of weak references to the object (if defined)

class solvcon.helper.Gmsh(cmds, preserve=False)

Variables:cmds – Commands to be sent to gmsh.

Delegate Gmsh command through journaling file and load the generated mesh.

__call__(options=None)

Returns:The loaded Gmsh object. Return type:solvcon.io.gmsh.Gmsh

Launch Gmsh for generating mesh and then load the generated file.

__init__(cmds, preserve=False)

>>> gmh = Gmsh(["lc = 0.1;"])
>>> gmh = Gmsh(["lc = 0.1;"], preserve=True)

__weakref__

list of weak references to the object (if defined)

class solvcon.helper.Information(prefix='*', nchar=4, width=80, level=0, muted=False)

Information logger.

__call__(data, travel=0, level=None, has_gap=True)

Parameters:data (str) – String data to be output.

Output.

__weakref__

list of weak references to the object (if defined)

streams

Type :list

List of output streams.

class solvcon.helper.Printer(streams, **kw)

Print message to a stream.

__weakref__

list of weak references to the object (if defined)

solvcon.helper.generate_apidoc(outputdir='doc/api')

Use epydoc to generate API doc.

solvcon.helper.iswin()

Returns:Flag under windows or not. Return type:bool

solvcon.helper.search_in_parents(loc, name)

Parameters:

• loc (str) – The location to start searching.
• name (str) – The searching target.

Returns:

The absolute path to the FS item.

Return type:

str

Search for something in the file system all the way up from the specified location to the root.

solvcon.io.gmsh

This is a loader for Gmsh format. Currently only the ASCII format is supported.

For more information about Gmsh ASCII file, please refer to http://www.geuz.org/gmsh/doc/texinfo/gmsh.html#MSH-ASCII-file-format