ogs5py.fileclasses.pct

Class for the ogs PARTICLE DEFINITION file for RANDOM_WALK.

File Class

PCT([data, s_flag, task_root, task_id]) Class for the ogs Particle file, if the PCS TYPE is RANDOM_WALK.

class PCT(data=None, s_flag=1, task_root=None, task_id='model')[source]

Bases: ogs5py.fileclasses.base.File

Class for the ogs Particle file, if the PCS TYPE is RANDOM_WALK.

Parameters:
  • data (np.array or None) – particle data. Default: None
  • s_flag (int, optional) – 1 for same pseudo-random series, 0 for different pseudo-random series. Default: 1
  • task_root (str, optional) – Path to the destiny model folder. Default: cwd+”ogs5model”
  • task_id (str, optional) – Name for the ogs task. Default: “model”
Attributes:
file_name

str: base name of the file with extension.

file_path

str: save path of the file.

force_writing

bool: state if the file is written even if empty.

is_empty

State if the OGS file is empty.

name

str: name of the file without extension.

Methods

add_copy_link(self, path[, symlink]) Add a link to copy a file instead of writing.
check(self[, verbose]) Check if the external geometry definition is valid.
del_copy_link(self) Remove a former given link to an external file.
get_file_type(self) Get the OGS file class name.
read_file(self, path, \*\*kwargs) Write the actual OGS input file to the given folder.
reset(self) Delete every content.
save(self, path) Save the actual PCT external file in the given path.
write_file(self) Write the actual OGS input file to the given folder.

Add a link to copy a file instead of writing.

Instead of writing a file, you can give a path to an existing file, that will be copied/linked to the target folder.

Parameters:
  • path (str) – path to the existing file that should be copied
  • symlink (bool, optional) – on UNIX systems it is possible to use a symbolic link to save time if the file is big. Default: False
check(self, verbose=True)[source]

Check if the external geometry definition is valid.

In the sence, that the contained data is consistent.

Parameters:verbose (bool, optional) – Print information for the executed checks. Default: True
Returns:result – Validity of the given gli.
Return type:bool

Remove a former given link to an external file.

get_file_type(self)

Get the OGS file class name.

read_file(self, path, **kwargs)[source]

Write the actual OGS input file to the given folder.

Its path is given by “task_root+task_id+file_ext”.

reset(self)[source]

Delete every content.

save(self, path)[source]

Save the actual PCT external file in the given path.

Parameters:path (str) – path to where to file should be saved
write_file(self)

Write the actual OGS input file to the given folder.

Its path is given by “task_root+task_id+file_ext”.

file_name

base name of the file with extension.

Type:str
file_path

save path of the file.

Type:str
force_writing

state if the file is written even if empty.

Type:bool
is_empty

State if the OGS file is empty.

name

name of the file without extension.

Type:str