DynaSolver

class ansys.dyna.core.solver.dynasolver.DynaSolver(hostname='localhost', port='5000', channel=None, server_path='')

Provides the gRPC client-side of Ansys LS-DYNA.

Parameters:

hostnamestr

Host name or IP address to connect to.

portstr

Port the gRPC server is to listen on.

Returns:

An instance of the client, which can be used to communicate

with the gRPC server running at the given host name and port.

The client can then interact with LS-DYNA via gRPC.

Overview

Methods

list_files	Get size information about one or more files in the LS-DYNA
node	Get size information about a node in the model’s working directory.
pause	Pause LS-DYNA execution.
pull	Provide an alias for the download method for backward compatibility.
download	Download a file from the gRPC server.
push	Provide an alias for the upload method for backward compatibility.
upload	Upload a file to the LS-DYNA working directory.
quit	Terminate the gRPC server program. This does not terminate LS-DYNA.
resume	Resume execution.
run	Begin execution with the given string as the command-line arguments.
setlc	Set a load curve to a constant value.
start	Start LS-DYNA.
start_locally	Begin execution with the given string as the command-line arguments.
switch	Send a “sense switch” to LS-DYNA.
tail	Monitor the stdout or stderr of the running job.
time	Get the current cycle count and simulation time.
send	Send one request to LS-DYNA using the command-line interface.
runfile	Read command lines from a file and execute them.

Attributes

hostname
port
pim_client
remote_instance
working_dir
stub
logger

Static methods

get_appdata_path
downloadfile
grpc_local_server_on	Check if the server is launched locally.

Import detail

from ansys.dyna.core.solver.dynasolver import DynaSolver

Attribute detail

DynaSolver.hostname = 'localhost'

DynaSolver.port = '5000'

DynaSolver.pim_client = None

DynaSolver.remote_instance = None

DynaSolver.working_dir = None

DynaSolver.stub

DynaSolver.logger

Method detail

static DynaSolver.get_appdata_path()

static DynaSolver.downloadfile(url: str, fname: str)

static DynaSolver.grpc_local_server_on() → bool

Check if the server is launched locally.

Returns:

bool

True when successful, False when failed.

DynaSolver.list_files(subname=None)

Get size information about one or more files in the LS-DYNA working directory.

Parameters:

subnamestr, defaultNone

If given, only files whose names contain subname as a substring are returned. This check is case insensitive.

Returns:

Array of (filename, size in bytes) pairs.

DynaSolver.node(n)

Get size information about a node in the model’s working directory.

Parameters:

ninteger

User ID of a node in the model.

Returns:

A pair of 3-tuples are returned, giving the (x, y, z) coordinates and

velocities of the node. If the node number given does not exist

in the model, then (None, None) is returned.

DynaSolver.pause()

Pause LS-DYNA execution.

Execution stops until told to resume or quit. Most switch” commands result in one cycle being executed so that the switch can be handled, and then LS-DYNA pauses again.

DynaSolver.pull(fname)

Provide an alias for the download method for backward compatibility.

DynaSolver.download(fname)

Download a file from the gRPC server.

Parameters:

fnamestr

Name of the file to download. The file is downloaded to the current working directory of the calling process. The file name should not begin with a leading /. The file is interpreted relative to the LS-DYNA working directory.

Returns:

int

Number of bytes received.

DynaSolver.push(fname, workdir)

Provide an alias for the upload method for backward compatibility.

DynaSolver.upload(fname)

Upload a file to the LS-DYNA working directory.

Parameters:

fnamestr

Name of the local file to upload. The contents of this file are copied into the LS-DYNA working directory in a file of the same name, but with any path components removed.

Returns:

int

Number of bytes sent.

DynaSolver.quit()

Terminate the gRPC server program. This does not terminate LS-DYNA.

If the server is running inside a container, it ignore this command and continues running.

DynaSolver.resume(cycle=None, time=None)

Resume execution.

Parameters:

cycleinteger, optional

Cycle to pause execution on. The default is None.

timefloat, optional

Ssimulation time to pause execution at. The default is None.

This command can be given whether LS-DYNA is paused or running.

LS-DYNA runs until the given cycle number or simulation time. If

both are given, it stops based on whichever occurs first. If

neither are given, it runs until termination or until paused.

DynaSolver.run(args)

Begin execution with the given string as the command-line arguments.

Parameters:

argsstr

Command line to pass to LS-DYNA.

DynaSolver.setlc(lc, value)

Set a load curve to a constant value.

Parameters:

lcint

User ID of the load curve to set.

valuefloat

Value to set the load curve to.

DynaSolver.start(nproc)

Start LS-DYNA.

The program starts and awaits further input. To begin a simulation, the run command must used to send the command line arguments.

After starting but before running, a resume command can be sent to set a pause time or cycle.

Parameters:

nprocint

Number of cores (MPI ranks) to run.

DynaSolver.start_locally(preset='MPP', input='', nproc=1, memory=20)

Begin execution with the given string as the command-line arguments.

Parameters:

argsstr

Command line to pass to LS-DYNA.

DynaSolver.switch(args)

Send a “sense switch” to LS-DYNA.

Parameters:

argsstr

Sense switch string.

Returns:

If the switch sent is sw2., a str is returned with the

usual status update information that a switch generates. Otherwise,

an empty str is returned.

DynaSolver.tail(which=1, how=2, queuesize=0)

Monitor the stdout or stderr of the running job.

Parameters:

whichint, optional

Which stream to monitor. The default is 1, in which case stdout is used. Otherwise, stderr is used.

howint, optional

How to handle the file data. The default is 2. Options are:

• 0: The file contents are printed to stdout, and this method does not return until LS-DYNA terminates.

• 1: A Queue instance is returned. The queue holds raw blocks of text as returned by the server.

• 2: A Queue instance is returned.The queue holds individual lines of text.

queuesizeint, optional

Size to use for the Queue instance if the how parameter is set to a value greater than 0.

Returns:

If the value for the how parameter is greater than 0, a Queue instance

is returned. When a call to the q.get() method returns None, all data

has been returned.

DynaSolver.time()

Get the current cycle count and simulation time.

Returns:

A (cycle_count, simulation_time) pair.

DynaSolver.send(cmdin)

Send one request to LS-DYNA using the command-line interface.

Parameters:

cmdinstr

Command to send.

Returns:

None

There is no data returned. Data that is returned from the underlying method call is just printed to the screen. This method is used to support the sample interactive client.py program.

Description	Example
“list” then optional file name	list d3plot
“list” then optional file name	list d3plot
“node” user node number	node 43444
“pause” (no arguments)	pause
“download” then file name	download glstat
“upload” then file name	upload input.k
“quit” (no arguments)	quit
“resume” optional cycle and/or time	resume 5000 0.25
“run” then the command line	run i=input.k jobid=xx
“setlc” user load curve number and value	setlc 1075 0.245
“start” number of processors	start 5
“switch” then switch text	switch sw2
“tail” then 1 for stdout, 2 for stderr	tail 1
“time” (no arguments)	time.

DynaSolver.runfile(fname)

Read command lines from a file and execute them.

Each line is read from the file and echoed to the screen. You must hit the enter key to trigger execution of the command.

Parameters:

fnamestr

File to read commands from.