aspect::Utilities::AsciiDataBase< dim > Class Template Reference

Inheritance diagram for aspect::Utilities::AsciiDataBase< dim >:

Public Member Functions
	AsciiDataBase ()
void	parse_parameters (ParameterHandler &prm, const std::string &subsection_name="Ascii data model")

Static Public Member Functions
static void	declare_parameters (ParameterHandler &prm, const std::string &default_directory, const std::string &default_filename, const std::string &subsection_name="Ascii data model")

Public Attributes
std::string	data_directory
std::string	data_file_name
double	scale_factor

Detailed Description

template<int dim>
class aspect::Utilities::AsciiDataBase< dim >

AsciDataBase is a generic plugin used for declaring and reading the parameters from the parameter file.

Definition at line 339 of file structured_data.h.

Constructor & Destructor Documentation

AsciiDataBase()

template<int dim>

aspect::Utilities::AsciiDataBase< dim >::AsciiDataBase

(

)

Constructor

Member Function Documentation

declare_parameters()

template<int dim>

static void aspect::Utilities::AsciiDataBase< dim >::declare_parameters ( ParameterHandler &  prm, const std::string &  default_directory, const std::string &  default_filename, const std::string &  subsection_name = "Ascii data model"  )

static

Declare the parameters all derived classes take from input files.

parse_parameters()

template<int dim>

void aspect::Utilities::AsciiDataBase< dim >::parse_parameters	(	ParameterHandler &	prm,
		const std::string &	subsection_name = "Ascii data model"
	)

Read the parameters from the parameter file.

Member Data Documentation

data_directory

template<int dim>

std::string aspect::Utilities::AsciiDataBase< dim >::data_directory

Directory in which the data files are present.

Definition at line 367 of file structured_data.h.

data_file_name

template<int dim>

std::string aspect::Utilities::AsciiDataBase< dim >::data_file_name

Filename of data file. The file names can contain the specifiers s and/or c (in this order), meaning the name of the boundary and the number of the data file time step.

Definition at line 374 of file structured_data.h.

scale_factor

template<int dim>

double aspect::Utilities::AsciiDataBase< dim >::scale_factor

Scale the data by a scalar factor. Can be used to transform the unit of the data (if they are not specified in SI units (m/s or m/yr depending on the "Use years instead of seconds" parameter).

Definition at line 382 of file structured_data.h.

---

The documentation for this class was generated from the following file:

• /home/bob/source/include/aspect/structured_data.h