serac::input Namespace Reference

The input related helper functions and objects. More...

Classes
struct	CoefficientInputOptions
	The information required from the input file for an mfem::(Vector)(Function)Coefficient. More...
struct	BoundaryConditionInputOptions
	The information required from the input file for a boundary condition. More...

Enumerations
enum class	Language { Lua , JSON , YAML }
	The input file languages supported by Inlet.

Functions
axom::inlet::Inlet	initialize (axom::sidre::DataStore &datastore, const std::string &input_file_path, const Language language=Language::Lua, const std::string &sidre_path="input_file")
	Initializes Inlet with the given datastore and input file. More...
std::string	findMeshFilePath (const std::string &mesh_path, const std::string &input_file_path)
	Returns the absolute path of the given mesh either relative to CWD or the input file. More...
std::string	fullDirectoryFromPath (const std::string &file_path)
	Returns the absolute directory of the given file path. More...
std::string	getInputFileName (const std::string &file_path)
	Returns the name of the input file (base name with file extension removed). More...
void	defineVectorInputFileSchema (axom::inlet::Container &container)
	Defines the schema for a vector in R^{1,2,3} space. More...

Detailed Description

The input related helper functions and objects.

Function Documentation

defineVectorInputFileSchema()

void serac::input::defineVectorInputFileSchema

(

axom::inlet::Container &

container

)

Defines the schema for a vector in R^{1,2,3} space.

Parameters

[in,out]

container

The base container on which to define the schema

Definition at line 96 of file input.cpp.

findMeshFilePath()

std::string serac::input::findMeshFilePath	(	const std::string &	mesh_path,
		const std::string &	input_file_path
	)

Returns the absolute path of the given mesh either relative to CWD or the input file.

Parameters

[in]	mesh_path	Given mesh path from input file
[in]	input_file_path	Path to user given input file

Returns

Absolute path of found file

Definition at line 46 of file input.cpp.

fullDirectoryFromPath()

std::string serac::input::fullDirectoryFromPath

(

const std::string &

file_path

)

Returns the absolute directory of the given file path.

Parameters

[in]

file_path

path to a file

Returns

Absolute directory of given file path

Definition at line 68 of file input.cpp.

getInputFileName()

std::string serac::input::getInputFileName

(

const std::string &

file_path

)

Returns the name of the input file (base name with file extension removed).

// TODO: remove when axom::Path supports this

Parameters

[in]

file_path

path to a file

Returns

name of input file

Definition at line 80 of file input.cpp.

initialize()

axom::inlet::Inlet serac::input::initialize	(	axom::sidre::DataStore &	datastore,
		const std::string &	input_file_path,
		const Language	language = Language::Lua,
		const std::string &	sidre_path = "input_file"
	)

Initializes Inlet with the given datastore and input file.

Parameters

[in]	datastore	Root of the Sidre datastore
[in]	input_file_path	Path to user given input file
[in]	language	The language of the file at input_file_path
[in]	sidre_path	The path within the datastore to use as the root of the Inlet hierarchy

Returns

initialized Inlet instance

Definition at line 20 of file input.cpp.