nimble::ModelDataBase Class Reference

#include <nimble_model_data_base.h>

Inheritance diagram for nimble::ModelDataBase:

Public Member Functions
	ModelDataBase ()=default
	Constructor.
virtual	~ModelDataBase ()=default
	Destructor.
virtual int	AllocateNodeData (Length length, std::string label, int num_objects)=0
	Allocate data storage for a node-based quantity.
int	GetFieldIdChecked (const std::string &field_label) const
virtual int	GetFieldId (const std::string &field_label) const =0
	Returns the field ID for a specific label.
virtual void	InitializeBlocks (nimble::DataManager &data_manager, const std::shared_ptr< nimble::MaterialFactoryBase > &material_factory_base)=0
	Initialize the different blocks in the mesh.
virtual void	UpdateStates (const nimble::DataManager &data_manager)=0
	Copy time state (n+1) into time state (n)
nimble::Viewify< 1 >	GetScalarNodeData (const std::string &label)
	Get view of scalar quantity defined on nodes.
virtual nimble::Viewify< 1 >	GetScalarNodeData (int field_id)=0
	Get view of scalar quantity defined on nodes.
nimble::Viewify< 2 >	GetVectorNodeData (const std::string &label)
	Get view of vector quantity defined on nodes.
virtual nimble::Viewify< 2 >	GetVectorNodeData (int field_id)=0
	Get view of scalar quantity defined on nodes.
virtual void	ComputeLumpedMass (nimble::DataManager &data_manager)=0
	Compute the lumped mass.
virtual void	InitializeExodusOutput (nimble::DataManager &data_manager)
virtual void	WriteExodusOutput (nimble::DataManager &data_manager, double time_current)
	Write output of simulation in Exodus format.
virtual void	ComputeExternalForce (nimble::DataManager &data_manager, double time_previous, double time_current, bool is_output_step)
	Compute the external force.
virtual void	ComputeInternalForce (nimble::DataManager &data_manager, double time_previous, double time_current, bool is_output_step, const nimble::Viewify< 2 > &displacement, nimble::Viewify< 2 > &force)
	Compute the internal force.
virtual void	ApplyInitialConditions (nimble::DataManager &data_manager)
	Apply initial conditions.
virtual void	ApplyKinematicConditions (nimble::DataManager &data_manager, double time_current, double time_previous)
	Apply kinematic conditions.
virtual void	UpdateWithNewVelocity (nimble::DataManager &data_manager, double dt)
	Update model with new velocity.
virtual void	UpdateWithNewDisplacement (nimble::DataManager &data_manager, double dt)
	Update model with new displacement.
int	GetDimension () const
	Get the spatial dimension.
void	SetCriticalTimeStep (double time_step)
	Set the critical time step.
void	SetDimension (int dim)
	Set spatial dimension.
void	SetReferenceCoordinates (const nimble::GenesisMesh &mesh)
	Set reference coordinates.
double	GetCriticalTimeStep () const
	Get the critical time step.
const std::vector< std::string > &	GetNodeDataLabelsForOutput () const
const std::map< int, std::vector< std::string > > &	GetElementDataLabels () const
const std::map< int, std::vector< std::string > > &	GetElementDataLabelsForOutput () const
const std::map< int, std::vector< std::string > > &	GetDerivedElementDataLabelsForOutput () const

Protected Attributes
int	dim_ = 3
	Problem dimension, either 2 or 3.
double	critical_time_step_ = 0.0
	Critical time step.
std::vector< std::string >	output_node_component_labels_
	Output labels for node data that will be written to disk.
std::map< int, std::vector< std::string > >	element_component_labels_
std::map< int, std::vector< std::string > >	output_element_component_labels_
	Output labels for element data that will be written to disk.
std::map< int, std::vector< std::string > >	derived_output_element_data_labels_
	Output labels for derived element data that will be written to disk.

Constructor & Destructor Documentation

ModelDataBase()

nimble::ModelDataBase::ModelDataBase ( )

default

Constructor.

~ModelDataBase()

virtual nimble::ModelDataBase::~ModelDataBase ( )

virtualdefault

Destructor.

Member Function Documentation

AllocateNodeData()

virtual int nimble::ModelDataBase::AllocateNodeData ( Length length, std::string label, int num_objects )

pure virtual

Allocate data storage for a node-based quantity.

Parameters

length
label
num_objects

Returns

Field ID for the data allocated

Implemented in nimble::ModelData, and nimble_kokkos::ModelData.

ApplyInitialConditions()

void nimble::ModelDataBase::ApplyInitialConditions ( nimble::DataManager & data_manager )

virtual

Apply initial conditions.

{
  auto bc                   = data_manager.GetBoundaryConditionManager();
  auto reference_coordinate = GetVectorNodeData("reference_coordinate");
  auto velocity             = GetVectorNodeData("velocity");
  bc->ApplyInitialConditions(reference_coordinate, velocity);
}

ApplyKinematicConditions()

void nimble::ModelDataBase::ApplyKinematicConditions ( nimble::DataManager & data_manager, double time_current, double time_previous )

virtual

Apply kinematic conditions.

{
  auto bc                   = data_manager.GetBoundaryConditionManager();
  auto reference_coordinate = GetVectorNodeData("reference_coordinate");
  auto velocity             = GetVectorNodeData("velocity");
  auto displacement         = GetVectorNodeData("displacement");
  bc->ApplyKinematicBC(time_current, time_previous, reference_coordinate, displacement, velocity);
}

ComputeExternalForce()

virtual void nimble::ModelDataBase::ComputeExternalForce ( nimble::DataManager & data_manager, double time_previous, double time_current, bool is_output_step )

inlinevirtual

Compute the external force.

Parameters

data_manager	Reference to the DataManager object
time_previous
time_current
is_output_step

Note

This routine is a placeholder.

Reimplemented in nimble::ModelData.

                                          {};

ComputeInternalForce()

virtual void nimble::ModelDataBase::ComputeInternalForce ( nimble::DataManager & data_manager, double time_previous, double time_current, bool is_output_step, const nimble::Viewify< 2 > & displacement, nimble::Viewify< 2 > & force )

inlinevirtual

Compute the internal force.

Parameters

[in]	data_manager
[in]	time_previous
[in]	time_current
[in]	is_output_step
[in]	displacement
[out]	internal_force	Output for internal force

Reimplemented in nimble::ModelData, and nimble_kokkos::ModelData.

                                    {};

ComputeLumpedMass()

virtual void nimble::ModelDataBase::ComputeLumpedMass ( nimble::DataManager & data_manager )

pure virtual

Compute the lumped mass.

Parameters

data_manager

Reference to the data manager

Implemented in nimble::ModelData, and nimble_kokkos::ModelData.

GetCriticalTimeStep()

double nimble::ModelDataBase::GetCriticalTimeStep ( ) const

inline

Get the critical time step.

Returns

Time step

  {
    return critical_time_step_;
  }

GetDerivedElementDataLabelsForOutput()

const std::map< int, std::vector< std::string > > & nimble::ModelDataBase::GetDerivedElementDataLabelsForOutput ( ) const

inline

  {
    return derived_output_element_data_labels_;
  }

GetDimension()

int nimble::ModelDataBase::GetDimension ( ) const

inline

Get the spatial dimension.

Returns

Spatial dimension

  {
    return dim_;
  }

GetElementDataLabels()

const std::map< int, std::vector< std::string > > & nimble::ModelDataBase::GetElementDataLabels ( ) const

inline

  {
    return element_component_labels_;
  }

GetElementDataLabelsForOutput()

const std::map< int, std::vector< std::string > > & nimble::ModelDataBase::GetElementDataLabelsForOutput ( ) const

inline

  {
    return output_element_component_labels_;
  }

GetFieldId()

virtual int nimble::ModelDataBase::GetFieldId ( const std::string & field_label ) const

pure virtual

Returns the field ID for a specific label.

Parameters

field_label

Label for a stored quantity

Returns

Field ID to identify the data storage

Implemented in nimble::ModelData, and nimble_kokkos::ModelData.

GetFieldIdChecked()

int nimble::ModelDataBase::GetFieldIdChecked ( const std::string & field_label ) const

inline

  {
    int id = GetFieldId(field_label);
    if (id < 0) {
      std::ostringstream errc;
      errc << "Field \"" << field_label << "\" not allocated";
      NIMBLE_ABORT(errc.str());
    }
    return id;
  }

GetNodeDataLabelsForOutput()

const std::vector< std::string > & nimble::ModelDataBase::GetNodeDataLabelsForOutput ( ) const

inline

  {
    return output_node_component_labels_;
  }

GetScalarNodeData() [1/2]

nimble::Viewify< 1 > nimble::ModelDataBase::GetScalarNodeData ( const std::string & label )

inline

Get view of scalar quantity defined on nodes.

Parameters

label

the data label

Returns

Viewify<1> object for scalar quantity

  {
    return GetScalarNodeData(GetFieldIdChecked(label));
  };

GetScalarNodeData() [2/2]

virtual nimble::Viewify< 1 > nimble::ModelDataBase::GetScalarNodeData ( int field_id )

pure virtual

Get view of scalar quantity defined on nodes.

Parameters

field_id

the field id (see DataManager::GetFieldIDs())

Returns

Viewify<1> object for scalar quantity

Implemented in nimble::ModelData, and nimble_kokkos::ModelData.

GetVectorNodeData() [1/2]

nimble::Viewify< 2 > nimble::ModelDataBase::GetVectorNodeData ( const std::string & label )

inline

Get view of vector quantity defined on nodes.

Parameters

label

the data label

Returns

Viewify<2> object for vector quantity

  {
    return GetVectorNodeData(GetFieldIdChecked(label));
  }

GetVectorNodeData() [2/2]

virtual nimble::Viewify< 2 > nimble::ModelDataBase::GetVectorNodeData ( int field_id )

pure virtual

Get view of scalar quantity defined on nodes.

Parameters

field_id

the field id (see DataManager::GetFieldIDs())

Returns

Viewify<2> object for vector quantity

Implemented in nimble::ModelData, and nimble_kokkos::ModelData.

InitializeBlocks()

virtual void nimble::ModelDataBase::InitializeBlocks ( nimble::DataManager & data_manager, const std::shared_ptr< nimble::MaterialFactoryBase > & material_factory_base )

pure virtual

Initialize the different blocks in the mesh.

Parameters

data_manager	Reference to the data manager
material_factory_base	Shared pointer to the material factory

Implemented in nimble::ModelData.

InitializeExodusOutput()

virtual void nimble::ModelDataBase::InitializeExodusOutput ( nimble::DataManager & data_manager )

inlinevirtual

Reimplemented in nimble::ModelData, and nimble_kokkos::ModelData.

  {
    NIMBLE_ABORT(" Exodus Output Not Implemented \n");
  }

SetCriticalTimeStep()

void nimble::ModelDataBase::SetCriticalTimeStep ( double time_step )

inline

Set the critical time step.

Parameters

time_step

Critical time step to use.

  {
    critical_time_step_ = time_step;
  }

SetDimension()

void nimble::ModelDataBase::SetDimension

(

int

dim

)

Set spatial dimension.

Parameters

dim	Spatial dimension

{
  if (dim != 2 && dim != 3) throw std::invalid_argument("\nError:  Invalid dimension in ModelData\n");
  dim_ = dim;
}

SetReferenceCoordinates()

void nimble::ModelDataBase::SetReferenceCoordinates

(

const nimble::GenesisMesh &

mesh

)

Set reference coordinates.

Parameters

mesh

Mesh

{
  const double* const ref_coord_x = mesh.GetCoordinatesX();
  const double* const ref_coord_y = mesh.GetCoordinatesY();
  const double* const ref_coord_z = mesh.GetCoordinatesZ();
  //
  auto reference_coordinate = GetVectorNodeData("reference_coordinate");
  int  num_nodes            = static_cast<int>(mesh.GetNumNodes());
  if (dim_ == 2) {
    for (int i = 0; i < num_nodes; i++) {
      reference_coordinate(i, 0) = ref_coord_x[i];
      reference_coordinate(i, 1) = ref_coord_y[i];
    }
  } else if (dim_ == 3) {
    for (int i = 0; i < num_nodes; i++) {
      reference_coordinate(i, 0) = ref_coord_x[i];
      reference_coordinate(i, 1) = ref_coord_y[i];
      reference_coordinate(i, 2) = ref_coord_z[i];
    }
  } else {
    throw std::invalid_argument(" -- Inappropriate Spatial Dimension");
  }
}

UpdateStates()

virtual void nimble::ModelDataBase::UpdateStates ( const nimble::DataManager & data_manager )

pure virtual

Copy time state (n+1) into time state (n)

Parameters

data_manager

Reference to the data manager

Implemented in nimble::ModelData, and nimble_kokkos::ModelData.

UpdateWithNewDisplacement()

virtual void nimble::ModelDataBase::UpdateWithNewDisplacement ( nimble::DataManager & data_manager, double dt )

inlinevirtual

Update model with new displacement.

Parameters

[in]	data_manager	Reference to the data manager
[in]	dt	Current time step

Note

This routine is usually empty. The UQ model data is one case using this routine.

Reimplemented in nimble_kokkos::ModelData.

  {
  }

UpdateWithNewVelocity()

virtual void nimble::ModelDataBase::UpdateWithNewVelocity ( nimble::DataManager & data_manager, double dt )

inlinevirtual

Update model with new velocity.

Parameters

[in]	data_manager	Reference to the data manager
[in]	dt	Current time step

Note

This routine is usually empty. The UQ model data is one case using this routine.

Reimplemented in nimble_kokkos::ModelData.

  {
  }

WriteExodusOutput()

virtual void nimble::ModelDataBase::WriteExodusOutput ( nimble::DataManager & data_manager, double time_current )

inlinevirtual

Write output of simulation in Exodus format.

Parameters

[in]	data_manager	Reference to data manager
[in]	time_current	Time value

Reimplemented in nimble::ModelData, and nimble_kokkos::ModelData.

  {
    NIMBLE_ABORT(" Exodus Output Not Implemented \n");
  }

Member Data Documentation

critical_time_step_

double nimble::ModelDataBase::critical_time_step_ = 0.0

protected

Critical time step.

derived_output_element_data_labels_

std::map<int, std::vector<std::string> > nimble::ModelDataBase::derived_output_element_data_labels_

protected

Output labels for derived element data that will be written to disk.

dim_

int nimble::ModelDataBase::dim_ = 3

protected

Problem dimension, either 2 or 3.

element_component_labels_

std::map<int, std::vector<std::string> > nimble::ModelDataBase::element_component_labels_

protected

Map key is the block_id, vector contains component-wise label for each scalar entry in the data array.

output_element_component_labels_

std::map<int, std::vector<std::string> > nimble::ModelDataBase::output_element_component_labels_

protected

Output labels for element data that will be written to disk.

output_node_component_labels_

std::vector<std::string> nimble::ModelDataBase::output_node_component_labels_

protected

Output labels for node data that will be written to disk.

---

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

• src/nimble_model_data_base.h
• src/nimble_model_data_base.cc