elmerkw module

This module is an extension of the elmer module. It provides some keywords ready-to-use. Unfortunately, it is far from being complete.

Implementation of solver-specific keywords for backward compatibility. If you don’t know what this is please use elmer.py instead.

class pyelmer.elmerkw.BodyForce(simulation, name, data=None)

Bases: BodyForce

Wrapper for body forces in sif-file.

__init__(simulation, name, data=None)

Create body force object.

Parameters:
  • simulation (Simulation Object) – The body force is added to this simulation object.

  • name (str) – Name of the body force

  • data (dict) – Body force data as in sif-file.

current_density

fixed current density, defaults to 0

get_data()

Generate dictionary with data for sif-file.

heat_source

fixed heat source, defaults to 0

integral_heat_source

fixed integral heat source, defaults to 0

joule_heat

joule heating activated, defaults to False

smart_heat_control

smart heat control, defaults to False

smart_heater_T

smart heater temperature, defaults to 0

smart_heater_control_point

control point for smart heater, defaults to []

class pyelmer.elmerkw.Boundary(simulation, name, geo_ids=None, data=None)

Bases: Boundary

Wrapper for boundaries in sif-file.

T_ext

external temperature, defaults to 0

__init__(simulation, name, geo_ids=None)

Create boundary object.

Parameters:
  • simulation (Simulation Object) – The boundary is added to this simulation object.

  • name (str) – Name of the body

  • surf_ids (list of int) – Ids of boundaries in mesh.

fixed_heatflux

fixed heat flux, defaults to None

fixed_temperature

fixed temperature, defaults to None

get_data()

Generate dictionary with data for sif-file.

heat_transfer_coefficient

heat transfer coefficient, defaults to 0

material

reference to material object, defaults to None

mesh_update

mesh update velocity, defaults to []

phase_change_vel

phase change velocity, defaults to 0

radiation

surface to surface radiation, defaults to False

save_line

add save line flag, defaults to False

save_scalars

add save scalars flag, defaults to False

smart_heater

add smart heater flag, defaults to False

smart_heater_T

smart heater temperature, defaults to 0

zero_potential

zero potential, defaults to False